Lines Matching +full:- +full:- +full:disable +full:- +full:coroutine +full:- +full:pool
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
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',
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',
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
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)
555 # @dirty-bitmaps: dirty bitmaps information (only present if node has
561 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
575 'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } }
586 # @nospace: The last I/O operation has failed due to a no-space
607 # @busy: true if the bitmap is in-use by some operation (NBD or jobs)
617 # it, use @block-dirty-bitmap-remove. (Since 4.0)
631 # @in-use: This flag is set by any process actively modifying the
643 'data': ['in-use', 'auto'] }
682 # +------------------
712 # @io-status: @BlockDeviceIoStatus. Only present if the device
714 # (supported device models: virtio-blk, IDE, SCSI except
715 # scsi-generic)
725 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus' } }
745 # copying just allocated guest-visible contents.
747 # @fully-allocated: Image file size, in bytes, once data has been
748 # written to all sectors, when copying just guest-visible
751 # @bitmaps: Additional size required if all the top-level bitmap
759 'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} }
762 # @query-block:
771 # .. qmp-example::
773 # -> { "execute": "query-block" }
774 # <- {
777 # "io-status": "ok",
778 # "device":"ide0-hd0",
805 # "virtual-size":2048000,
807 # "full-backing-filename":"disks/base.qcow2",
808 # "backing-filename-format":"qcow2",
813 # "vm-state-size": 0,
814 # "date-sec": 10000200,
815 # "date-nsec": 12,
816 # "vm-clock-sec": 206,
817 # "vm-clock-nsec": 30
820 # "backing-image":{
823 # "virtual-size":2048000
831 # "io-status": "ok",
832 # "device":"ide1-cd0",
855 { 'command': 'query-block', 'returns': ['BlockInfo'],
856 'allow-preconfig': true }
1069 # @discard-nb-ok: The number of successful discard operations
1072 # @discard-nb-failed: The number of failed discard operations
1075 # @discard-bytes-ok: The number of bytes discarded by the driver.
1081 'discard-nb-ok': 'uint64',
1082 'discard-nb-failed': 'uint64',
1083 'discard-bytes-ok': 'uint64' } }
1090 # @completion-errors: The number of completion errors.
1092 # @aligned-accesses: The number of aligned accesses performed by the
1095 # @unaligned-accesses: The number of unaligned accesses performed by
1102 'completion-errors': 'uint64',
1103 'aligned-accesses': 'uint64',
1104 'unaligned-accesses': 'uint64' } }
1132 # @node-name: The node name of the device. (Since 2.3)
1139 # @driver-specific: Optional driver-specific stats. (Since 4.2)
1152 'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str',
1154 '*driver-specific': 'BlockStatsSpecific',
1159 # @query-blockstats:
1163 # @query-nodes: If true, the command will query all the block nodes
1166 # behavior is as before - query all the device backends,
1175 # .. qmp-example::
1177 # -> { "execute": "query-blockstats" }
1178 # <- {
1181 # "device":"ide0-hd0",
1219 # "device":"ide1-cd0",
1277 { 'command': 'query-blockstats',
1278 'data': { '*query-nodes': 'bool' },
1280 'allow-preconfig': true }
1339 # @on-success: The bitmap is only synced when the operation is
1344 # treated solely as a read-only manifest of blocks to copy.
1352 'data': ['on-success', 'never', 'always'] }
1362 # @write-blocking: when data is written to the source, write it
1369 'data': ['background', 'write-blocking'] }
1376 # @actively-synced: Whether the source is actively synced to the
1383 'data': { 'actively-synced': 'bool' } }
1388 # Information about a long-running block device operation.
1411 # @io-status: the status of the job (since 1.3)
1417 # @auto-finalize: Job will finalize itself when PENDING, moving to the
1420 # @auto-dismiss: Job will dismiss itself when CONCLUDED, and
1431 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool',
1433 'auto-finalize': 'bool', 'auto-dismiss': 'bool',
1439 # @query-block-jobs:
1441 # Return information about long-running block device operations.
1447 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'],
1448 'allow-preconfig': true }
1455 # Either @device or @node-name must be set but not both.
1459 # @node-name: graph node name to get the image resized (Since 2.0)
1464 # - If @device is not a valid block device, DeviceNotFound
1468 # .. qmp-example::
1470 # -> { "execute": "block_resize",
1472 # <- { "return": {} }
1476 '*node-name': 'str',
1478 'coroutine': true,
1479 'allow-preconfig': true }
1489 # @absolute-paths: QEMU should create a new image with absolute paths
1496 'data': [ 'existing', 'absolute-paths' ] }
1501 # Either @device or @node-name must be set but not both.
1505 # @node-name: graph node name to generate the snapshot from
1508 # @snapshot-file: the target of the new overlay image. If the file
1512 # @snapshot-node-name: the graph node name of the new image
1518 # 'absolute-paths'.
1521 'data': { '*device': 'str', '*node-name': 'str',
1522 'snapshot-file': 'str', '*snapshot-node-name': 'str',
1533 # "backing": null to blockdev-add).
1546 # @use-copy-range: Use copy offloading. Default false.
1548 # @max-workers: Maximum number of parallel requests for the sustained
1549 # background copying process. Doesn't influence copy-before-write
1552 # @max-chunk: Maximum request length for the sustained background
1553 # copying process. Doesn't influence copy-before-write
1554 # operations. 0 means unlimited. If max-chunk is non-zero then
1558 # @min-cluster-size: Minimum size of blocks used by copy-before-write
1566 'data': { '*use-copy-range': 'bool', '*max-workers': 'int',
1567 '*max-chunk': 'int64', '*min-cluster-size': 'size' } }
1572 # @job-id: identifier for the newly-created block job. If omitted,
1575 # @device: the device name or node-name of a root node which should be
1588 # (Since 2.4 (drive-backup), 3.1 (blockdev-backup))
1590 # @bitmap-mode: Specifies the type of data the bitmap should contain
1597 # @on-source-error: the action to take on an error on the source,
1599 # block device supports io-status (see BlockInfo).
1601 # @on-target-error: the action to take on an error on the target,
1605 # @on-cbw-error: policy defining behavior on I/O errors in
1606 # copy-before-write jobs; defaults to break-guest-write. (Since 10.1)
1608 # @auto-finalize: When false, this job will wait in a PENDING state
1609 # after it has finished its work, waiting for @job-finalize before
1614 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
1616 # @job-dismiss. When true, this job will automatically disappear
1619 # @filter-node-name: the node name that should be assigned to the
1624 # @discard-source: Discard blocks on source which have already been
1627 # @x-perf: Performance options. (Since 6.0)
1631 # @unstable: Member @x-perf is experimental.
1633 # .. note:: @on-source-error and @on-target-error only affect
1640 'data': { '*job-id': 'str', 'device': 'str',
1642 '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode',
1644 '*on-source-error': 'BlockdevOnError',
1645 '*on-target-error': 'BlockdevOnError',
1646 '*on-cbw-error': 'OnCbwError',
1647 '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
1648 '*filter-node-name': 'str',
1649 '*discard-source': 'bool',
1650 '*x-perf': { 'type': 'BackupPerf',
1664 # 'absolute-paths'.
1677 # @target: the device name or node-name of the backup target node.
1686 # @blockdev-snapshot-sync:
1691 # - If @device is not a valid block device, DeviceNotFound
1695 # .. qmp-example::
1697 # -> { "execute": "blockdev-snapshot-sync",
1698 # "arguments": { "device": "ide-hd0",
1699 # "snapshot-file":
1700 # "/some/place/my-image",
1702 # <- { "return": {} }
1704 { 'command': 'blockdev-snapshot-sync',
1706 'allow-preconfig': true }
1709 # @blockdev-snapshot:
1720 # @allow-write-only-overlay: If present, the check whether this
1722 # backing file of a destination of a blockdev-mirror. (since 5.0)
1726 # .. qmp-example::
1728 # -> { "execute": "blockdev-add",
1730 # "node-name": "node1534",
1735 # <- { "return": {} }
1737 # -> { "execute": "blockdev-snapshot",
1738 # "arguments": { "node": "ide-hd0",
1740 # <- { "return": {} }
1742 { 'command': 'blockdev-snapshot',
1744 'features': [ 'allow-write-only-overlay' ],
1745 'allow-preconfig': true }
1748 # @change-backing-file:
1752 # (it may, however, perform a reopen to change permissions from r/o ->
1753 # r/w -> r/o, if needed). The new backing file string is written into
1756 # @image-node-name: The name of the block driver state node of the
1758 # "image-node-name" is in the chain described by "device".
1760 # @device: The device name or node-name of the root node that owns
1761 # image-node-name.
1763 # @backing-file: The string to write as the backing file. This string
1768 # - If "device" does not exist or cannot be determined,
1773 { 'command': 'change-backing-file',
1774 'data': { 'device': 'str', 'image-node-name': 'str',
1775 'backing-file': 'str' },
1776 'allow-preconfig': true }
1779 # @block-commit:
1781 # Live commit of data from overlay image nodes into backing nodes -
1787 # job-complete command after getting the ready event. (Since 2.0)
1795 # @job-id: identifier for the newly-created block job. If omitted,
1798 # @device: the device name or node-name of a root node
1800 # @base-node: The node name of the backing image to write data into.
1804 # @base: Same as @base-node, except that it is a file name rather than
1809 # @top-node: The node name of the backing image within the image chain
1813 # @top: Same as @top-node, except that it is a file name rather than a
1818 # @backing-file: The backing file string to write into the overlay
1825 # QMP or HMP commands must use node-names for the image in
1833 # @backing-mask-protocol: If true, replace any protocol mentioned in
1840 # @on-error: the action to take on an error. 'ignore' means that the
1843 # @filter-node-name: the node name that should be assigned to the
1848 # @auto-finalize: When false, this job will wait in a PENDING state
1849 # after it has finished its work, waiting for @job-finalize before
1854 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
1856 # @job-dismiss. When true, this job will automatically disappear
1861 # @deprecated: Members @base and @top are deprecated. Use @base-node
1862 # and @top-node instead.
1865 # - If @device does not exist, DeviceNotFound
1869 # .. qmp-example::
1871 # -> { "execute": "block-commit",
1874 # <- { "return": {} }
1876 { 'command': 'block-commit',
1877 'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str',
1879 '*top-node': 'str',
1881 '*backing-file': 'str', '*backing-mask-protocol': 'bool',
1883 '*on-error': 'BlockdevOnError',
1884 '*filter-node-name': 'str',
1885 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' },
1886 'allow-preconfig': true }
1889 # @drive-backup:
1891 # Start a point-in-time copy of a block device to a new destination.
1892 # The status of ongoing drive-backup operations can be checked with
1893 # query-block-jobs where the BlockJobInfo.type field has the value
1895 # using the job-cancel or block-job-cancel command.
1899 # @deprecated: This command is deprecated. Use @blockdev-backup
1903 # - If @device is not a valid block device, GenericError
1907 # .. qmp-example::
1909 # -> { "execute": "drive-backup",
1913 # <- { "return": {} }
1915 { 'command': 'drive-backup', 'boxed': true,
1917 'allow-preconfig': true }
1920 # @blockdev-backup:
1922 # Start a point-in-time copy of a block device to a new destination.
1923 # The status of ongoing blockdev-backup operations can be checked with
1924 # query-block-jobs where the BlockJobInfo.type field has the value
1926 # using the job-cancel or block-job-cancel command.
1929 # - If @device is not a valid block device, DeviceNotFound
1933 # .. qmp-example::
1935 # -> { "execute": "blockdev-backup",
1936 # "arguments": { "device": "src-id",
1938 # "target": "tgt-id" } }
1939 # <- { "return": {} }
1941 { 'command': 'blockdev-backup', 'boxed': true,
1943 'allow-preconfig': true }
1946 # @query-named-block-nodes:
1950 # @flat: Omit the nested data about backing image ("backing-image"
1957 # .. qmp-example::
1959 # -> { "execute": "query-named-block-nodes" }
1960 # <- { "return": [ { "ro":false,
1964 # "node-name": "my-node",
1984 # "virtual-size":2048000,
1986 # "full-backing-filename":"disks/base.qcow2",
1987 # "backing-filename-format":"qcow2",
1992 # "vm-state-size": 0,
1993 # "date-sec": 10000200,
1994 # "date-nsec": 12,
1995 # "vm-clock-sec": 206,
1996 # "vm-clock-nsec": 30
1999 # "backing-image":{
2002 # "virtual-size":2048000
2006 { 'command': 'query-named-block-nodes',
2009 'allow-preconfig': true }
2014 # @block-backend: corresponds to BlockBackend
2016 # @block-job: corresponds to BlockJob
2018 # @block-driver: corresponds to BlockDriverState
2023 'data': [ 'block-backend', 'block-job', 'block-driver' ] }
2029 # x-debug-query-block-graph and does not relate to any other
2032 # @type: Type of graph node. Can be one of block-backend, block-job
2033 # or block-driver-state.
2035 # @name: Human readable name of the node. Corresponds to node-name
2036 # for block-driver-state nodes; is not guaranteed to be unique in
2037 # the whole graph (with block-jobs and block-backends).
2049 # @consistent-read: A user that has the "permission" of consistent
2051 # device is complete and self-consistent, representing the
2060 # @write-unchanged: This permission (which is weaker than
2073 'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize' ] }
2078 # Block Graph edge description for x-debug-query-block-graph.
2088 # @shared-perm: permissions that can still be granted to other users
2096 'shared-perm': [ 'BlockPermission' ] } }
2101 # Block Graph - list of nodes and list of edges.
2109 # @x-debug-query-block-graph:
2119 { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph',
2121 'allow-preconfig': true }
2124 # @drive-mirror:
2134 # - If @device is not a valid block device, GenericError
2138 # .. qmp-example::
2140 # -> { "execute": "drive-mirror",
2141 # "arguments": { "device": "ide-hd0",
2142 # "target": "/some/place/my-image",
2145 # <- { "return": {} }
2147 { 'command': 'drive-mirror', 'boxed': true,
2149 'allow-preconfig': true }
2156 # @job-id: identifier for the newly-created block job. If omitted,
2159 # @device: the device name or node-name of a root node whose writes
2169 # @node-name: the new block driver state node name in the graph
2178 # 'absolute-paths'.
2191 # @buf-size: maximum amount of data in flight from source to target
2194 # @on-source-error: the action to take on an error on the source,
2196 # block device supports io-status (see BlockInfo).
2198 # @on-target-error: the action to take on an error on the target,
2208 # @copy-mode: when to copy data to the destination; defaults to
2211 # @auto-finalize: When false, this job will wait in a PENDING state
2212 # after it has finished its work, waiting for @job-finalize before
2217 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2219 # @job-dismiss. When true, this job will automatically disappear
2225 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2226 '*format': 'str', '*node-name': 'str', '*replaces': 'str',
2229 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2230 '*on-target-error': 'BlockdevOnError',
2231 '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode',
2232 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } }
2254 # block-dirty-bitmap-add
2259 # for block-dirty-bitmap-add. (Since: 2.10)
2263 # with block-dirty-bitmap-enable. Default is false. (Since: 4.0)
2303 # @block-dirty-bitmap-add:
2309 # - If @node is not a valid block device or node, DeviceNotFound
2310 # - If @name is already taken, GenericError
2314 # .. qmp-example::
2316 # -> { "execute": "block-dirty-bitmap-add",
2318 # <- { "return": {} }
2320 { 'command': 'block-dirty-bitmap-add',
2322 'allow-preconfig': true }
2325 # @block-dirty-bitmap-remove:
2328 # with block-dirty-bitmap-add. If the bitmap is persistent, remove it
2332 # - If @node is not a valid block device or node, DeviceNotFound
2333 # - If @name is not found, GenericError
2334 # - if @name is frozen by an operation, GenericError
2338 # .. qmp-example::
2340 # -> { "execute": "block-dirty-bitmap-remove",
2342 # <- { "return": {} }
2344 { 'command': 'block-dirty-bitmap-remove',
2346 'allow-preconfig': true }
2349 # @block-dirty-bitmap-clear:
2356 # - If @node is not a valid block device, DeviceNotFound
2357 # - If @name is not found, GenericError
2361 # .. qmp-example::
2363 # -> { "execute": "block-dirty-bitmap-clear",
2365 # <- { "return": {} }
2367 { 'command': 'block-dirty-bitmap-clear',
2369 'allow-preconfig': true }
2372 # @block-dirty-bitmap-enable:
2377 # - If @node is not a valid block device, DeviceNotFound
2378 # - If @name is not found, GenericError
2382 # .. qmp-example::
2384 # -> { "execute": "block-dirty-bitmap-enable",
2386 # <- { "return": {} }
2388 { 'command': 'block-dirty-bitmap-enable',
2390 'allow-preconfig': true }
2393 # @block-dirty-bitmap-disable:
2398 # - If @node is not a valid block device, DeviceNotFound
2399 # - If @name is not found, GenericError
2403 # .. qmp-example::
2405 # -> { "execute": "block-dirty-bitmap-disable",
2407 # <- { "return": {} }
2409 { 'command': 'block-dirty-bitmap-disable',
2411 'allow-preconfig': true }
2414 # @block-dirty-bitmap-merge:
2427 # - If @node is not a valid block device, DeviceNotFound
2428 # - If any bitmap in @bitmaps or @target is not found,
2430 # - If any of the bitmaps have different sizes or granularities,
2435 # .. qmp-example::
2437 # -> { "execute": "block-dirty-bitmap-merge",
2440 # <- { "return": {} }
2442 { 'command': 'block-dirty-bitmap-merge',
2444 'allow-preconfig': true }
2459 # @x-debug-block-dirty-bitmap-sha256:
2471 # - If @node is not a valid block device, DeviceNotFound
2472 # - If @name is not found or if hashing has failed, GenericError
2476 { 'command': 'x-debug-block-dirty-bitmap-sha256',
2479 'allow-preconfig': true }
2482 # @blockdev-mirror:
2486 # @job-id: identifier for the newly-created block job. If omitted,
2489 # @device: The device name or node-name of a root node whose writes
2492 # @target: the id or node-name of the block device to mirror to. This
2511 # @buf-size: maximum amount of data in flight from source to target
2513 # @on-source-error: the action to take on an error on the source,
2515 # block device supports io-status (see BlockInfo).
2517 # @on-target-error: the action to take on an error on the target,
2521 # @filter-node-name: the node name that should be assigned to the
2526 # @copy-mode: when to copy data to the destination; defaults to
2529 # @auto-finalize: When false, this job will wait in a PENDING state
2530 # after it has finished its work, waiting for @job-finalize before
2535 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2537 # @job-dismiss. When true, this job will automatically disappear
2540 # @target-is-zero: Assume the destination reads as all zeroes before
2547 # .. qmp-example::
2549 # -> { "execute": "blockdev-mirror",
2550 # "arguments": { "device": "ide-hd0",
2553 # <- { "return": {} }
2555 { 'command': 'blockdev-mirror',
2556 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
2560 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
2561 '*on-target-error': 'BlockdevOnError',
2562 '*filter-node-name': 'str',
2563 '*copy-mode': 'MirrorCopyMode',
2564 '*auto-finalize': 'bool', '*auto-dismiss': 'bool',
2565 '*target-is-zero': 'bool'},
2566 'allow-preconfig': true }
2660 # @iops-total: limit total I/O operations per second
2662 # @iops-total-max: I/O operations burst
2664 # @iops-total-max-length: length of the iops-total-max burst period,
2665 # in seconds. It must only be set if @iops-total-max is set as
2668 # @iops-read: limit read operations per second
2670 # @iops-read-max: I/O operations read burst
2672 # @iops-read-max-length: length of the iops-read-max burst period, in
2673 # seconds. It must only be set if @iops-read-max is set as well.
2675 # @iops-write: limit write operations per second
2677 # @iops-write-max: I/O operations write burst
2679 # @iops-write-max-length: length of the iops-write-max burst period,
2680 # in seconds. It must only be set if @iops-write-max is set as
2683 # @bps-total: limit total bytes per second
2685 # @bps-total-max: total bytes burst
2687 # @bps-total-max-length: length of the bps-total-max burst period, in
2688 # seconds. It must only be set if @bps-total-max is set as well.
2690 # @bps-read: limit read bytes per second
2692 # @bps-read-max: total bytes read burst
2694 # @bps-read-max-length: length of the bps-read-max burst period, in
2695 # seconds. It must only be set if @bps-read-max is set as well.
2697 # @bps-write: limit write bytes per second
2699 # @bps-write-max: total bytes write burst
2701 # @bps-write-max-length: length of the bps-write-max burst period, in
2702 # seconds. It must only be set if @bps-write-max is set as well.
2704 # @iops-size: when limiting by iops max size of an I/O in bytes
2709 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int',
2710 '*iops-total-max-length' : 'int', '*iops-read' : 'int',
2711 '*iops-read-max' : 'int', '*iops-read-max-length' : 'int',
2712 '*iops-write' : 'int', '*iops-write-max' : 'int',
2713 '*iops-write-max-length' : 'int', '*bps-total' : 'int',
2714 '*bps-total-max' : 'int', '*bps-total-max-length' : 'int',
2715 '*bps-read' : 'int', '*bps-read-max' : 'int',
2716 '*bps-read-max-length' : 'int', '*bps-write' : 'int',
2717 '*bps-write-max' : 'int', '*bps-write-max-length' : 'int',
2718 '*iops-size' : 'int' } }
2723 # Properties for throttle-group objects.
2729 # @unstable: All members starting with x- are aliases for the same key
2730 # without x- in the @limits object. This is not a stable
2738 '*x-iops-total': { 'type': 'int',
2740 '*x-iops-total-max': { 'type': 'int',
2742 '*x-iops-total-max-length': { 'type': 'int',
2744 '*x-iops-read': { 'type': 'int',
2746 '*x-iops-read-max': { 'type': 'int',
2748 '*x-iops-read-max-length': { 'type': 'int',
2750 '*x-iops-write': { 'type': 'int',
2752 '*x-iops-write-max': { 'type': 'int',
2754 '*x-iops-write-max-length': { 'type': 'int',
2756 '*x-bps-total': { 'type': 'int',
2758 '*x-bps-total-max': { 'type': 'int',
2760 '*x-bps-total-max-length': { 'type': 'int',
2762 '*x-bps-read': { 'type': 'int',
2764 '*x-bps-read-max': { 'type': 'int',
2766 '*x-bps-read-max-length': { 'type': 'int',
2768 '*x-bps-write': { 'type': 'int',
2770 '*x-bps-write-max': { 'type': 'int',
2772 '*x-bps-write-max-length': { 'type': 'int',
2774 '*x-iops-size': { 'type': 'int',
2778 # @block-stream:
2785 # streaming operations can be checked with query-block-jobs. The
2787 # job-cancel or block-job-cancel command.
2793 # node; presence of the 'base-node' parameter during introspection can
2808 # In case @device is a filter node, block-stream modifies the first
2809 # non-filter overlay node below it to point to the new backing node
2812 # @job-id: identifier for the newly-created block job. If omitted,
2817 # @base: the common backing file name. It cannot be set if @base-node
2820 # @base-node: the node name of the backing file. It cannot be set if
2824 # top. It cannot be set if @base or @base-node is also set. It
2827 # @backing-file: The backing file string to write into the top image.
2832 # node-names for the image in question, as filename lookup methods
2840 # @backing-mask-protocol: If true, replace any protocol mentioned in
2847 # @on-error: the action to take on an error (default report). 'stop'
2849 # io-status (see BlockInfo). (Since 1.3)
2851 # @filter-node-name: the node name that should be assigned to the
2856 # @auto-finalize: When false, this job will wait in a PENDING state
2857 # after it has finished its work, waiting for @job-finalize before
2862 # @auto-dismiss: When false, this job will wait in a CONCLUDED state
2864 # @job-dismiss. When true, this job will automatically disappear
2868 # - If @device does not exist, DeviceNotFound.
2872 # .. qmp-example::
2874 # -> { "execute": "block-stream",
2877 # <- { "return": {} }
2879 { 'command': 'block-stream',
2880 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
2881 '*base-node': 'str', '*backing-file': 'str',
2882 '*backing-mask-protocol': 'bool',
2884 '*speed': 'int', '*on-error': 'BlockdevOnError',
2885 '*filter-node-name': 'str',
2886 '*auto-finalize': 'bool', '*auto-dismiss': 'bool' },
2887 'allow-preconfig': true }
2890 # @block-job-set-speed:
2906 # - If no background operation is active on this device,
2911 { 'command': 'block-job-set-speed',
2913 'allow-preconfig': true }
2916 # @block-job-cancel:
2926 # visible when enumerated using query-block-jobs.
2928 # Note that if you issue 'block-job-cancel' after 'drive-mirror' has
2932 # mirroring has ended and the destination now has a point-in-time copy
2950 # - If no background operation is active on this device,
2955 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' },
2956 'allow-preconfig': true }
2959 # @block-job-pause:
2978 # @deprecated: This command is deprecated. Use @job-pause
2982 # - If no background operation is active on this device,
2987 { 'command': 'block-job-pause', 'data': { 'device': 'str' },
2989 'allow-preconfig': true }
2992 # @block-job-resume:
3007 # @deprecated: This command is deprecated. Use @job-resume
3011 # - If no background operation is active on this device,
3016 { 'command': 'block-job-resume', 'data': { 'device': 'str' },
3018 'allow-preconfig': true }
3021 # @block-job-complete:
3028 # mirroring includes drive-mirror, blockdev-mirror and block-commit
3047 # @deprecated: This command is deprecated. Use @job-complete
3051 # - If no background operation is active on this device,
3056 { 'command': 'block-job-complete', 'data': { 'device': 'str' },
3058 'allow-preconfig': true }
3061 # @block-job-dismiss:
3066 # for jobs that have @auto-dismiss option, which are drive-backup,
3067 # blockdev-backup, drive-mirror, blockdev-mirror, block-commit and
3068 # block-stream. @auto-dismiss is enabled by default for these
3073 # the BLOCK_JOB_READY event, job-cancel, block-job-cancel or
3074 # job-complete will still need to be used as appropriate.
3080 # @deprecated: This command is deprecated. Use @job-dismiss
3085 { 'command': 'block-job-dismiss', 'data': { 'id': 'str' },
3087 'allow-preconfig': true }
3090 # @block-job-finalize:
3101 # The command is applicable only to jobs which have @auto-finalize option
3108 # @deprecated: This command is deprecated. Use @job-finalize
3113 { 'command': 'block-job-finalize', 'data': { 'id': 'str' },
3115 'allow-preconfig': true }
3120 # @copy-mode: Switch to this copy mode. Currently, only the switch
3121 # from 'background' to 'write-blocking' is implemented.
3126 'data': { 'copy-mode' : 'MirrorCopyMode' } }
3145 # @block-job-change:
3151 { 'command': 'block-job-change',
3193 # @threads: Use QEMU's thread pool
3208 # Includes cache-related options for block devices
3213 # @no-flush: ignore any flush requests for the device (default: false)
3219 '*no-flush': 'bool' } }
3230 # @copy-on-read: Since 3.0
3238 # @copy-before-write: Since 6.2
3240 # @snapshot-access: Since 7.0
3251 'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg',
3252 'file', 'snapshot-access', 'ftp', 'ftps',
3259 'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme',
3260 { 'name': 'nvme-io_uring', 'if': 'CONFIG_BLKIO' },
3265 { 'name': 'virtio-blk-vfio-pci', 'if': 'CONFIG_BLKIO' },
3266 { 'name': 'virtio-blk-vhost-user', 'if': 'CONFIG_BLKIO' },
3267 { 'name': 'virtio-blk-vhost-vdpa', 'if': 'CONFIG_BLKIO' },
3277 # @pr-manager: the id for the object that will handle persistent
3283 # @aio-max-batch: maximum number of requests to batch together into a
3285 # between this and the aio-max-batch value of the IOThread object
3293 # @drop-cache: invalidate page cache during live migration. This
3298 # @x-check-cache-dropped: whether to check that page cache was dropped
3305 # @dynamic-auto-read-only: If present, enabled auto-read-only means
3306 # that the driver will open the image read-only at first,
3307 # dynamically reopen the image file read-write when the first
3308 # writer is attached to the node and reopen read-only when the
3313 # @unstable: Member x-check-cache-dropped is meant for debugging.
3319 '*pr-manager': 'str',
3322 '*aio-max-batch': 'int',
3323 '*drop-cache': {'type': 'bool',
3325 '*x-check-cache-dropped': { 'type': 'bool',
3327 'features': [ { 'name': 'dynamic-auto-read-only',
3337 # @latency-ns: emulated latency (in nanoseconds) in processing
3341 # @read-zeroes: if true, reads from the device produce zeroes; if
3348 'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } }
3375 # @fat-type: FAT type: 12, 16 or 32
3390 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
3411 # @key-secret: the ID of a QCryptoSecret object providing the
3412 # decryption key. Mandatory except when doing a metadata-only
3421 'data': { '*key-secret': 'str',
3472 # @main-header: Qcow2 format header
3474 # @active-l1: Qcow2 active L1 table
3476 # @active-l2: Qcow2 active L2 table
3478 # @refcount-table: Qcow2 refcount table
3480 # @refcount-block: Qcow2 refcount blocks
3482 # @snapshot-table: Qcow2 snapshot table
3484 # @inactive-l1: Qcow2 inactive L1 tables
3486 # @inactive-l2: Qcow2 inactive L2 tables
3488 # @bitmap-directory: Qcow2 bitmap directory (since 3.0)
3494 '*main-header': 'bool',
3495 '*active-l1': 'bool',
3496 '*active-l2': 'bool',
3497 '*refcount-table': 'bool',
3498 '*refcount-block': 'bool',
3499 '*snapshot-table': 'bool',
3500 '*inactive-l1': 'bool',
3501 '*inactive-l2': 'bool',
3502 '*bitmap-directory': 'bool' } }
3524 # @aes: AES-CBC with plain64 initialization vectors
3549 # except when doing a metadata-only probe of the image.
3560 # @aes: AES-CBC with plain64 initialization vectors
3586 # @prealloc-align: on preallocation, align file length to this number,
3589 # @prealloc-size: how much to preallocate, default 134217728 (128M)
3595 'data': { '*prealloc-align': 'int', '*prealloc-size': 'int' } }
3602 # @lazy-refcounts: whether to enable the lazy refcounts feature
3605 # @pass-discard-request: whether discard requests to the qcow2 device
3608 # @pass-discard-snapshot: whether discard requests for the data source
3612 # @pass-discard-other: whether discard requests for the data source
3615 # @discard-no-unref: when enabled, data clusters will remain
3619 # image file) depends on the setting of the pass-discard-request
3622 # re-allocating them later. Besides potential performance
3630 # @overlap-check: which overlap checks to perform for writes to the
3633 # @cache-size: the maximum total size of the L2 table and refcount
3636 # @l2-cache-size: the maximum size of the L2 table cache in bytes
3639 # @l2-cache-entry-size: the size of each entry in the L2 cache in
3643 # @refcount-cache-size: the maximum size of the refcount block cache
3646 # @cache-clean-interval: clean unused entries in the L2 and refcount
3652 # except when doing a metadata-only probe of the image.
3655 # @data-file: reference to or definition of the external data file.
3664 'data': { '*lazy-refcounts': 'bool',
3665 '*pass-discard-request': 'bool',
3666 '*pass-discard-snapshot': 'bool',
3667 '*pass-discard-other': 'bool',
3668 '*discard-no-unref': 'bool',
3669 '*overlap-check': 'Qcow2OverlapChecks',
3670 '*cache-size': 'int',
3671 '*l2-cache-size': 'int',
3672 '*l2-cache-entry-size': 'int',
3673 '*refcount-cache-size': 'int',
3674 '*cache-clean-interval': 'int',
3676 '*data-file': 'BlockdevRef' } }
3740 # @host-key-check: Defines how and what to check the host key against
3749 '*host-key-check': 'SshHostKeyCheck' } }
3761 # @cor_write: a write due to copy-on-read (since 2.11)
3797 # @write-zeroes: .bdrv_co_pwrite_zeroes()
3803 # @block-status: .bdrv_co_block_status()
3808 'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush',
3809 'block-status' ] }
3822 # injected; defaults to "all read, write, write-zeroes, discard,
3849 # Describes a single state-change event for blkdebug.
3878 # @max-transfer: maximum size for I/O transfers in bytes, must be
3883 # @opt-write-zero: preferred alignment for write zero requests in
3888 # @max-write-zero: maximum size for write zero requests in bytes, must
3889 # be positive multiple of @align, of @opt-write-zero, and of the
3893 # @opt-discard: preferred alignment for discard requests in bytes,
3898 # @max-discard: maximum size for discard requests in bytes, must be
3899 # positive multiple of @align, of @opt-discard, and of the
3903 # @inject-error: array of error injection descriptions
3905 # @set-state: array of state-change descriptions
3907 # @take-child-perms: Permissions to take on @image in addition to what
3911 # @unshare-child-perms: Permissions not to share on @image in addition
3920 '*align': 'int', '*max-transfer': 'int32',
3921 '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
3922 '*opt-discard': 'int32', '*max-discard': 'int32',
3923 '*inject-error': ['BlkdebugInjectErrorOptions'],
3924 '*set-state': ['BlkdebugSetStateOptions'],
3925 '*take-child-perms': ['BlockPermission'],
3926 '*unshare-child-perms': ['BlockPermission'] } }
3937 # @log-sector-size: sector size used in logging writes to @file,
3941 # @log-append: append to an existing log (default: false)
3943 # @log-super-update-interval: interval of write requests after which
3951 '*log-sector-size': 'uint32',
3952 '*log-append': 'bool',
3953 '*log-super-update-interval': 'uint64' } }
4005 # @vote-threshold: the vote limit under which a read will fail
4007 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
4010 # @read-pattern: choose read pattern and set to quorum by default
4018 'vote-threshold': 'int',
4019 '*rewrite-corrupted': 'bool',
4020 '*read-pattern': 'QuorumReadPattern' } }
4062 # Driver specific block device options for the nvme-io_uring backend.
4076 # Driver specific block device options for the virtio-blk-vfio-pci
4091 # Driver specific block device options for the virtio-blk-vhost-user
4094 # @path: path to the vhost-user UNIX domain socket.
4105 # Driver specific block device options for the virtio-blk-vhost-vdpa
4108 # @path: path to the vhost-vdpa character device.
4142 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
4160 # @password-secret: The ID of a QCryptoSecret object providing the
4164 # @initiator-name: The iqn name we want to identify to the target as.
4168 # @header-digest: The desired header digest. Defaults to none-crc32c.
4181 '*password-secret': 'str',
4182 '*initiator-name': 'str',
4183 '*header-digest': 'IscsiHeaderDigest',
4197 # @luks-any: Used for opening either luks or luks2 (Since 8.0)
4202 'data': [ 'luks', 'luks2', 'luks-any' ] }
4207 # @key-secret: ID of a QCryptoSecret object providing a passphrase for
4213 'data': { 'key-secret': 'str' } }
4218 # @cipher-alg: The encryption algorithm
4224 'data': { '*cipher-alg': 'QCryptoCipherAlgo' } }
4289 'luks-any': 'RbdEncryptionOptionsLUKSAny'} }
4307 # @pool: Ceph pool name.
4309 # @namespace: Rados namespace name in the Ceph pool. (Since 5.0)
4311 # @image: Image name in the Ceph pool.
4322 # @auth-client-required: Acceptable authentication modes. This maps
4326 # @key-secret: ID of a QCryptoSecret object providing a key for cephx
4336 'data': { 'pool': 'str',
4343 '*auth-client-required': ['RbdAuthMode'],
4344 '*key-secret': 'str',
4370 # @top-id: In secondary mode, node name or device ID of the root node
4379 '*top-id': 'str' },
4424 # @tcp-syn-count: number of SYNs during the session establishment
4427 # @readahead-size: set the readahead size in bytes (defaults to libnfs
4430 # @page-cache-size: set the pagecache size in bytes (defaults to
4442 '*tcp-syn-count': 'int',
4443 '*readahead-size': 'int',
4444 '*page-cache-size': 'int',
4455 # @readahead: Size of the read-ahead cache; must be a multiple of 512
4462 # @password-secret: ID of a QCryptoSecret object providing a password
4465 # @proxy-username: Username for proxy authentication (defaults to
4468 # @proxy-password-secret: ID of a QCryptoSecret object providing a
4478 '*password-secret': 'str',
4479 '*proxy-username': 'str',
4480 '*proxy-password-secret': 'str' } }
4492 # @cookie-secret: ID of a QCryptoSecret object providing the cookie
4500 '*cookie-secret': 'str'} }
4515 # @cookie-secret: ID of a QCryptoSecret object providing the cookie
4524 '*cookie-secret': 'str'} }
4562 # @tls-creds: TLS credentials ID
4564 # @tls-hostname: TLS hostname override for certificate validation
4567 # @x-dirty-bitmap: A metadata context name such as
4568 # "qemu:dirty-bitmap:NAME" or "qemu:allocation-depth" to query in
4571 # this option x-context would have made more sense) (since 3.0)
4573 # @reconnect-delay: On an unexpected disconnect, the nbd client tries
4575 # error. During the first @reconnect-delay seconds, all requests
4581 # @open-timeout: In seconds. If zero, the nbd driver tries the
4583 # If non-zero, the nbd driver will repeat connection attempts
4584 # until successful or until @open-timeout seconds have elapsed.
4589 # @unstable: Member @x-dirty-bitmap is experimental.
4596 '*tls-creds': 'str',
4597 '*tls-hostname': 'str',
4598 '*x-dirty-bitmap': { 'type': 'str', 'features': [ 'unstable' ] },
4599 '*reconnect-delay': 'uint32',
4600 '*open-timeout': 'uint32' } }
4622 # @throttle-group: the name of the throttle-group object to use. It
4630 'data': { 'throttle-group': 'str',
4637 # Driver specific block device options for the copy-on-read driver.
4639 # @bottom: The name of a non-filter node (allocation-bearing layer)
4654 # An enumeration of possible behaviors for copy-before-write operation
4657 # @break-guest-write: report the error to the guest. This way, the
4661 # @break-snapshot: continue guest write. Doing so will make the
4668 'data': [ 'break-guest-write', 'break-snapshot' ] }
4673 # Driver specific block device options for the copy-before-write
4674 # driver, which does so called copy-before-write operations: when data
4681 # @target: The target for copy-before-write operations.
4683 # @bitmap: If specified, copy-before-write filter will do
4684 # copy-before-write operations only for dirty regions of the
4691 # @on-cbw-error: Behavior on failure of copy-before-write operation.
4692 # Default is @break-guest-write. (Since 7.1)
4694 # @cbw-timeout: Zero means no limit. Non-zero sets the timeout in
4695 # seconds for copy-before-write operation. When a timeout occurs,
4696 # the respective copy-before-write operation will fail, and the
4697 # @on-cbw-error parameter will decide how this failure is handled.
4700 # @min-cluster-size: Minimum size of blocks used by copy-before-write
4710 '*on-cbw-error': 'OnCbwError', '*cbw-timeout': 'uint32',
4711 '*min-cluster-size': 'size' } }
4721 # @node-name: the node name of the new node. This option is required
4722 # on the top level of blockdev-add. Valid node names start with
4724 # characters, '-', '.' and '_'. Their maximum length is 31
4727 # @discard: discard-related options (default: ignore)
4729 # @cache: cache-related options
4736 # @read-only: whether the block device should be read-only (default:
4737 # false). Note that some block drivers support only read-only
4742 # @auto-read-only: if true and @read-only is false, QEMU may
4743 # automatically decide not to open the image read-write as
4744 # requested, but fall back to read-only instead (and switch
4749 # @detect-zeroes: detect and optimize zero writes (Since 2.1)
4752 # @force-share: force share all permission on added nodes. Requires
4753 # read-only=true. (Since 2.10)
4759 '*node-name': 'str',
4763 '*read-only': 'bool',
4764 '*auto-read-only': 'bool',
4765 '*force-share': 'bool',
4766 '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
4776 'copy-before-write':'BlockdevOptionsCbw',
4777 'copy-on-read':'BlockdevOptionsCor',
4795 'null-aio': 'BlockdevOptionsNull',
4796 'null-co': 'BlockdevOptionsNull',
4798 'nvme-io_uring': { 'type': 'BlockdevOptionsNvmeIoUring',
4810 'snapshot-access': 'BlockdevOptionsGenericFormat',
4815 'virtio-blk-vfio-pci':
4818 'virtio-blk-vhost-user':
4821 'virtio-blk-vhost-vdpa':
4865 # @blockdev-add:
4871 # .. qmp-example::
4873 # -> { "execute": "blockdev-add",
4876 # "node-name": "test1",
4883 # <- { "return": {} }
4885 # .. qmp-example::
4887 # -> { "execute": "blockdev-add",
4890 # "node-name": "node0",
4909 # <- { "return": {} }
4911 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true,
4912 'allow-preconfig': true }
4915 # @blockdev-reopen:
4926 # one of them, the top-level @node-name option (from BlockdevOptions)
4928 # reopened. Other @node-name options must be either omitted or set to
4949 # Unlike with blockdev-add, the @backing option must always be present
4956 { 'command': 'blockdev-reopen',
4958 'allow-preconfig': true }
4961 # @blockdev-del:
4963 # Deletes a block device that has been added using blockdev-add. The
4967 # @node-name: Name of the graph node to delete.
4971 # .. qmp-example::
4973 # -> { "execute": "blockdev-add",
4976 # "node-name": "node0",
4983 # <- { "return": {} }
4985 # -> { "execute": "blockdev-del",
4986 # "arguments": { "node-name": "node0" }
4988 # <- { "return": {} }
4990 { 'command': 'blockdev-del', 'data': { 'node-name': 'str' },
4991 'allow-preconfig': true }
4994 # @blockdev-set-active:
4997 # block devices on migration with qemu-storage-daemon.
5003 # @node-name: Name of the graph node to activate or inactivate. By default, all
5011 # .. qmp-example::
5013 # -> { "execute": "blockdev-set-active",
5015 # "node-name": "node0",
5019 # <- { "return": {} }
5021 { 'command': 'blockdev-set-active',
5022 'data': { '*node-name': 'str', 'active': 'bool' },
5023 'allow-preconfig': true }
5038 # @nocow: Turn off copy-on-write (valid only on btrfs; default: off)
5040 # @extent-size-hint: Extent size hint to add to the image file; 0 for
5050 '*extent-size-hint': 'size'} }
5120 # @cluster-size: Cluster size in bytes (default: 1 MB)
5127 '*cluster-size': 'size' } }
5138 # @backing-file: File name of the backing file if a backing file
5148 '*backing-file': 'str',
5185 # @data-file: Node to use as an external data file in which all guest
5189 # @data-file-raw: True if the external data file must stay valid as a
5190 # standalone (read-only) raw image without looking at qcow2
5193 # @extended-l2: True to make the image have extended L2 entries
5200 # @backing-file: File name of the backing file if a backing file
5203 # @backing-fmt: Name of the block driver to use for the backing file
5207 # @cluster-size: qcow2 cluster size in bytes (default: 65536)
5212 # @lazy-refcounts: True if refcounts may be updated lazily
5215 # @refcount-bits: Width of reference counts in bits (default: 16)
5217 # @compression-type: The image cluster compression method
5224 '*data-file': 'BlockdevRef',
5225 '*data-file-raw': 'bool',
5226 '*extended-l2': 'bool',
5229 '*backing-file': 'str',
5230 '*backing-fmt': 'BlockdevDriver',
5232 '*cluster-size': 'size',
5234 '*lazy-refcounts': 'bool',
5235 '*refcount-bits': 'int',
5236 '*compression-type':'Qcow2CompressionType' } }
5247 # @backing-file: File name of the backing file if a backing file
5250 # @backing-fmt: Name of the block driver to use for the backing file
5252 # @cluster-size: Cluster size in bytes (default: 65536)
5254 # @table-size: L1/L2 table size (in clusters)
5261 '*backing-file': 'str',
5262 '*backing-fmt': 'BlockdevDriver',
5263 '*cluster-size': 'size',
5264 '*table-size': 'int' } }
5276 # @cluster-size: RBD object size
5285 '*cluster-size' : 'size',
5343 # @backing-file: The path of backing file. Default: no backing file
5346 # @adapter-type: The adapter type used to fill in the descriptor.
5355 # @zeroed-grain: Whether to enable zeroed-grain feature for sparse
5365 '*backing-file': 'str',
5366 '*adapter-type': 'BlockdevVmdkAdapterType',
5369 '*zeroed-grain': 'bool' } }
5410 # @fixed: Preallocated fixed-size image file
5426 # @log-size: Log size in bytes, must be a multiple of 1 MB (default: 1
5429 # @block-size: Block size in bytes, must be a multiple of 1 MB and not
5435 # @block-state-zero: Force use of payload blocks of type 'ZERO'.
5436 # Non-standard, but default. Do not set to 'off' when using
5437 # 'qemu-img convert' with subformat=dynamic.
5444 '*log-size': 'size',
5445 '*block-size': 'size',
5447 '*block-state-zero': 'bool' } }
5454 # @fixed: Preallocated fixed-size image file
5472 # @force-size: Force use of the exact byte size instead of rounding to
5482 '*force-size': 'bool' } }
5515 # @blockdev-create:
5518 # automatically finalized, but a manual job-dismiss is required.
5520 # @job-id: Identifier for the newly created job.
5526 { 'command': 'blockdev-create',
5527 'data': { 'job-id': 'str',
5529 'allow-preconfig': true }
5574 # @x-blockdev-amend:
5578 # job-dismiss is required.
5580 # @job-id: Identifier for the newly created job.
5582 # @node-name: Name of the block node to work on
5597 { 'command': 'x-blockdev-amend',
5598 'data': { 'job-id': 'str',
5599 'node-name': 'str',
5603 'allow-preconfig': true }
5633 # @node-name: node name (Since: 2.4)
5652 # .. qmp-example::
5654 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
5655 # "data": { "device": "", "node-name": "drive", "fatal": false,
5663 '*node-name' : 'str',
5674 # @qom-path: path to the device object in the QOM tree (since 9.2)
5680 # @node-name: node name. Note that errors may be reported for the
5689 # @nospace: true if I/O error was caused due to a no-space condition.
5690 # This key is only present if query-block's io-status is present,
5691 # please see query-block documentation for more information
5701 # .. note:: This event is rate-limited.
5705 # .. qmp-example::
5707 # <- { "event": "BLOCK_IO_ERROR",
5708 # "data": { "qom-path": "/machine/unattached/device[0]",
5709 # "device": "ide0-hd1",
5710 # "node-name": "#block212",
5717 'data': { 'qom-path': 'str', 'device': 'str', '*node-name': 'str',
5740 # contains a human-readable error message. There are no semantics
5746 # .. qmp-example::
5748 # <- { "event": "BLOCK_JOB_COMPLETED",
5749 # "data": { "type": "stream", "device": "virtio-disk0",
5781 # .. qmp-example::
5783 # <- { "event": "BLOCK_JOB_CANCELLED",
5784 # "data": { "type": "stream", "device": "virtio-disk0",
5810 # .. qmp-example::
5812 # <- { "event": "BLOCK_JOB_ERROR",
5813 # "data": { "device": "ide0-hd1",
5845 # .. qmp-example::
5847 # <- { "event": "BLOCK_JOB_READY",
5863 # finalize graph changes via @job-finalize. If this job is part
5873 # .. qmp-example::
5875 # <- { "event": "BLOCK_JOB_PENDING",
5909 # configured write threshold. For thin-provisioned devices, this
5912 # re-registered with another block-set-write-threshold command.
5914 # @node-name: graph node name on which the threshold was exceeded.
5916 # @amount-exceeded: amount of data which exceeded the threshold, in
5919 # @write-threshold: last configured threshold, in bytes.
5924 'data': { 'node-name': 'str',
5925 'amount-exceeded': 'uint64',
5926 'write-threshold': 'uint64' } }
5929 # @block-set-write-threshold:
5933 # threshold. The threshold is an offset, thus must be non-negative.
5937 # This is useful to transparently resize thin-provisioned drives
5940 # @node-name: graph node name on which the threshold must be set.
5942 # @write-threshold: configured threshold for the block device, bytes.
5943 # Use 0 to disable the threshold.
5947 # .. qmp-example::
5949 # -> { "execute": "block-set-write-threshold",
5950 # "arguments": { "node-name": "mydev",
5951 # "write-threshold": 17179869184 } }
5952 # <- { "return": {} }
5954 { 'command': 'block-set-write-threshold',
5955 'data': { 'node-name': 'str', 'write-threshold': 'uint64' },
5956 'allow-preconfig': true }
5959 # @x-blockdev-change:
5988 # .. qmp-example::
5991 # -> { "execute": "blockdev-add",
5994 # "node-name": "new_node",
5997 # <- { "return": {} }
5998 # -> { "execute": "x-blockdev-change",
6001 # <- { "return": {} }
6003 # .. qmp-example::
6006 # -> { "execute": "x-blockdev-change",
6009 # <- { "return": {} }
6011 { 'command': 'x-blockdev-change',
6016 'allow-preconfig': true }
6019 # @x-blockdev-set-iothread:
6026 # @node-name: the name of the block driver node
6040 # .. qmp-example::
6043 # -> { "execute": "x-blockdev-set-iothread",
6044 # "arguments": { "node-name": "disk1",
6046 # <- { "return": {} }
6048 # .. qmp-example::
6051 # -> { "execute": "x-blockdev-set-iothread",
6052 # "arguments": { "node-name": "disk1",
6054 # <- { "return": {} }
6056 { 'command': 'x-blockdev-set-iothread',
6057 'data' : { 'node-name': 'str',
6061 'allow-preconfig': true }
6086 # @sector-num: number of the first sector of the failed read operation
6088 # @sectors-count: failed read operation sector count
6090 # .. note:: This event is rate-limited.
6094 # .. qmp-example::
6096 # <- { "event": "QUORUM_FAILURE",
6097 # "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
6101 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } }
6111 # contains a human-readable error message. There are no semantics
6115 # @node-name: the graph node name of the block driver state
6117 # @sector-num: number of the first sector of the failed read operation
6119 # @sectors-count: failed read operation sector count
6121 # .. note:: This event is rate-limited.
6125 # .. qmp-example::
6128 # <- { "event": "QUORUM_REPORT_BAD",
6129 # "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
6133 # .. qmp-example::
6136 # <- { "event": "QUORUM_REPORT_BAD",
6137 # "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
6142 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str',
6143 'sector-num': 'int', 'sectors-count': 'int' } }
6148 # @device: the device name or node-name of a root node to generate the
6159 # @blockdev-snapshot-internal-sync:
6167 # - If @device is not a valid block device, GenericError
6168 # - If any snapshot matching @name exists, or @name is empty,
6170 # - If the format of the image used does not support it,
6178 # .. qmp-example::
6180 # -> { "execute": "blockdev-snapshot-internal-sync",
6181 # "arguments": { "device": "ide-hd0",
6184 # <- { "return": {} }
6186 { 'command': 'blockdev-snapshot-internal-sync',
6188 'allow-preconfig': true }
6191 # @blockdev-snapshot-delete-internal-sync:
6198 # @device: the device name or node-name of a root node to delete the
6209 # - If @device is not a valid block device, GenericError
6210 # - If snapshot not found, GenericError
6211 # - If the format of the image used does not support it,
6213 # - If @id and @name are both not specified, GenericError
6217 # .. qmp-example::
6219 # -> { "execute": "blockdev-snapshot-delete-internal-sync",
6220 # "arguments": { "device": "ide-hd0",
6223 # <- { "return": {
6226 # "vm-state-size": 0,
6227 # "date-sec": 1000012,
6228 # "date-nsec": 10,
6229 # "vm-clock-sec": 100,
6230 # "vm-clock-nsec": 20,
6235 { 'command': 'blockdev-snapshot-delete-internal-sync',
6238 'allow-preconfig': true }
6248 'data': { 'unused-block-graph-info': ['BlockGraphInfo'] } }