Manpages - qemu-storage-daemon-qmp-ref.7

• QEMU Storage Daemon QMP Reference Manual
  • Block devices
    • Block core (VM unrelated)
  • Common data types
    • IoOperationType (Enum)
    • OnOffAuto (Enum)
    • OnOffSplit (Enum)
    • String (Object)
    • StrOrNull (Alternate)
    • OffAutoPCIBAR (Enum)
    • PCIELinkSpeed (Enum)
    • PCIELinkWidth (Enum)
    • HostMemPolicy (Enum)
    • NetFilterDirection (Enum)
    • GrabToggleKeys (Enum)
    • HumanReadableText (Object)
  • Cryptography
    • QCryptoTLSCredsEndpoint (Enum)
    • QCryptoSecretFormat (Enum)
    • QCryptoHashAlgorithm (Enum)
    • QCryptoCipherAlgorithm (Enum)
    • QCryptoCipherMode (Enum)
    • QCryptoIVGenAlgorithm (Enum)
    • QCryptoBlockFormat (Enum)
    • QCryptoBlockOptionsBase (Object)
    • QCryptoBlockOptionsQCow (Object)
    • QCryptoBlockOptionsLUKS (Object)
    • QCryptoBlockCreateOptionsLUKS (Object)
    • QCryptoBlockOpenOptions (Object)
    • QCryptoBlockCreateOptions (Object)
    • QCryptoBlockInfoBase (Object)
    • QCryptoBlockInfoLUKSSlot (Object)
    • QCryptoBlockInfoLUKS (Object)
    • QCryptoBlockInfo (Object)
    • QCryptoBlockLUKSKeyslotState (Enum)
    • QCryptoBlockAmendOptionsLUKS (Object)
    • QCryptoBlockAmendOptions (Object)
    • SecretCommonProperties (Object)
    • SecretProperties (Object)
    • SecretKeyringProperties (Object)
    • TlsCredsProperties (Object)
    • TlsCredsAnonProperties (Object)
    • TlsCredsPskProperties (Object)
    • TlsCredsX509Properties (Object)
    • Background jobs
  • Socket data types
    • NetworkAddressFamily (Enum)
    • InetSocketAddressBase (Object)
    • InetSocketAddress (Object)
    • UnixSocketAddress (Object)
    • VsockSocketAddress (Object)
    • InetSocketAddressWrapper (Object)
    • UnixSocketAddressWrapper (Object)
    • VsockSocketAddressWrapper (Object)
    • StringWrapper (Object)
    • SocketAddressLegacy (Object)
    • SocketAddressType (Enum)
    • SocketAddress (Object)
    • SnapshotInfo (Object)
    • ImageInfoSpecificQCow2EncryptionBase (Object)
    • ImageInfoSpecificQCow2Encryption (Object)
    • ImageInfoSpecificQCow2 (Object)
    • ImageInfoSpecificVmdk (Object)
    • ImageInfoSpecificRbd (Object)
    • ImageInfoSpecificKind (Enum)
    • ImageInfoSpecificQCow2Wrapper (Object)
    • ImageInfoSpecificVmdkWrapper (Object)
    • ImageInfoSpecificLUKSWrapper (Object)
    • ImageInfoSpecificRbdWrapper (Object)
    • ImageInfoSpecific (Object)
    • ImageInfo (Object)
    • ImageCheck (Object)
    • MapEntry (Object)
    • BlockdevCacheInfo (Object)
    • BlockDeviceInfo (Object)
    • BlockDeviceIoStatus (Enum)
    • BlockDirtyInfo (Object)
    • Qcow2BitmapInfoFlags (Enum)
    • Qcow2BitmapInfo (Object)
    • BlockLatencyHistogramInfo (Object)
    • BlockInfo (Object)
    • BlockMeasureInfo (Object)
    • query-block (Command)
    • BlockDeviceTimedStats (Object)
    • BlockDeviceStats (Object)
    • BlockStatsSpecificFile (Object)
    • BlockStatsSpecificNvme (Object)
    • BlockStatsSpecific (Object)
    • BlockStats (Object)
    • query-blockstats (Command)
    • BlockdevOnError (Enum)
    • MirrorSyncMode (Enum)
    • BitmapSyncMode (Enum)
    • MirrorCopyMode (Enum)
    • BlockJobInfo (Object)
    • query-block-jobs (Command)
    • block_resize (Command)
    • NewImageMode (Enum)
    • BlockdevSnapshotSync (Object)
    • BlockdevSnapshot (Object)
    • BackupPerf (Object)
    • BackupCommon (Object)
    • DriveBackup (Object)
    • BlockdevBackup (Object)
    • blockdev-snapshot-sync (Command)
    • blockdev-snapshot (Command)
    • change-backing-file (Command)
    • block-commit (Command)
    • drive-backup (Command)
    • blockdev-backup (Command)
    • query-named-block-nodes (Command)
    • XDbgBlockGraphNodeType (Enum)
    • XDbgBlockGraphNode (Object)
    • BlockPermission (Enum)
    • XDbgBlockGraphEdge (Object)
    • XDbgBlockGraph (Object)
    • x-debug-query-block-graph (Command)
    • drive-mirror (Command)
    • DriveMirror (Object)
    • BlockDirtyBitmap (Object)
    • BlockDirtyBitmapAdd (Object)
    • BlockDirtyBitmapMergeSource (Alternate)
    • BlockDirtyBitmapMerge (Object)
    • block-dirty-bitmap-add (Command)
    • block-dirty-bitmap-remove (Command)
    • block-dirty-bitmap-clear (Command)
    • block-dirty-bitmap-enable (Command)
    • block-dirty-bitmap-disable (Command)
    • block-dirty-bitmap-merge (Command)
    • BlockDirtyBitmapSha256 (Object)
    • x-debug-block-dirty-bitmap-sha256 (Command)
    • blockdev-mirror (Command)
    • BlockIOThrottle (Object)
    • ThrottleLimits (Object)
    • ThrottleGroupProperties (Object)
    • block-stream (Command)
    • block-job-set-speed (Command)
    • block-job-cancel (Command)
    • block-job-pause (Command)
    • block-job-resume (Command)
    • block-job-complete (Command)
    • block-job-dismiss (Command)
    • block-job-finalize (Command)
    • BlockdevDiscardOptions (Enum)
    • BlockdevDetectZeroesOptions (Enum)
    • BlockdevAioOptions (Enum)
    • BlockdevCacheOptions (Object)
    • BlockdevDriver (Enum)
    • BlockdevOptionsFile (Object)
    • BlockdevOptionsNull (Object)
    • BlockdevOptionsNVMe (Object)
    • BlockdevOptionsVVFAT (Object)
    • BlockdevOptionsGenericFormat (Object)
    • BlockdevOptionsLUKS (Object)
    • BlockdevOptionsGenericCOWFormat (Object)
    • Qcow2OverlapCheckMode (Enum)
    • Qcow2OverlapCheckFlags (Object)
    • Qcow2OverlapChecks (Alternate)
    • BlockdevQcowEncryptionFormat (Enum)
    • BlockdevQcowEncryption (Object)
    • BlockdevOptionsQcow (Object)
    • BlockdevQcow2EncryptionFormat (Enum)
    • BlockdevQcow2Encryption (Object)
    • BlockdevOptionsPreallocate (Object)
    • BlockdevOptionsQcow2 (Object)
    • SshHostKeyCheckMode (Enum)
    • SshHostKeyCheckHashType (Enum)
    • SshHostKeyHash (Object)
    • SshHostKeyCheck (Object)
    • BlockdevOptionsSsh (Object)
    • BlkdebugEvent (Enum)
    • BlkdebugIOType (Enum)
    • BlkdebugInjectErrorOptions (Object)
    • BlkdebugSetStateOptions (Object)
    • BlockdevOptionsBlkdebug (Object)
    • BlockdevOptionsBlklogwrites (Object)
    • BlockdevOptionsBlkverify (Object)
    • BlockdevOptionsBlkreplay (Object)
    • QuorumReadPattern (Enum)
    • BlockdevOptionsQuorum (Object)
    • BlockdevOptionsGluster (Object)
    • IscsiTransport (Enum)
    • IscsiHeaderDigest (Enum)
    • BlockdevOptionsIscsi (Object)
    • RbdAuthMode (Enum)
    • RbdImageEncryptionFormat (Enum)
    • RbdEncryptionOptionsLUKSBase (Object)
    • RbdEncryptionCreateOptionsLUKSBase (Object)
    • RbdEncryptionOptionsLUKS (Object)
    • RbdEncryptionOptionsLUKS2 (Object)
    • RbdEncryptionCreateOptionsLUKS (Object)
    • RbdEncryptionCreateOptionsLUKS2 (Object)
    • RbdEncryptionOptions (Object)
    • RbdEncryptionCreateOptions (Object)
    • BlockdevOptionsRbd (Object)
    • ReplicationMode (Enum)
    • BlockdevOptionsReplication (Object)
    • NFSTransport (Enum)
    • NFSServer (Object)
    • BlockdevOptionsNfs (Object)
    • BlockdevOptionsCurlBase (Object)
    • BlockdevOptionsCurlHttp (Object)
    • BlockdevOptionsCurlHttps (Object)
    • BlockdevOptionsCurlFtp (Object)
    • BlockdevOptionsCurlFtps (Object)
    • BlockdevOptionsNbd (Object)
    • BlockdevOptionsRaw (Object)
    • BlockdevOptionsThrottle (Object)
    • BlockdevOptionsCor (Object)
    • BlockdevOptionsCbw (Object)
    • BlockdevOptions (Object)
    • BlockdevRef (Alternate)
    • BlockdevRefOrNull (Alternate)
    • blockdev-add (Command)
    • blockdev-reopen (Command)
    • blockdev-del (Command)
    • BlockdevCreateOptionsFile (Object)
    • BlockdevCreateOptionsGluster (Object)
    • BlockdevCreateOptionsLUKS (Object)
    • BlockdevCreateOptionsNfs (Object)
    • BlockdevCreateOptionsParallels (Object)
    • BlockdevCreateOptionsQcow (Object)
    • BlockdevQcow2Version (Enum)
    • Qcow2CompressionType (Enum)
    • BlockdevCreateOptionsQcow2 (Object)
    • BlockdevCreateOptionsQed (Object)
    • BlockdevCreateOptionsRbd (Object)
    • BlockdevVmdkSubformat (Enum)
    • BlockdevVmdkAdapterType (Enum)
    • BlockdevCreateOptionsVmdk (Object)
    • BlockdevCreateOptionsSsh (Object)
    • BlockdevCreateOptionsVdi (Object)
    • BlockdevVhdxSubformat (Enum)
    • BlockdevCreateOptionsVhdx (Object)
    • BlockdevVpcSubformat (Enum)
    • BlockdevCreateOptionsVpc (Object)
    • BlockdevCreateOptions (Object)
    • blockdev-create (Command)
    • BlockdevAmendOptionsLUKS (Object)
    • BlockdevAmendOptionsQcow2 (Object)
    • BlockdevAmendOptions (Object)
    • x-blockdev-amend (Command)
    • BlockErrorAction (Enum)
    • BLOCK_IMAGE_CORRUPTED (Event)
    • BLOCK_IO_ERROR (Event)
    • BLOCK_JOB_COMPLETED (Event)
    • BLOCK_JOB_CANCELLED (Event)
    • BLOCK_JOB_ERROR (Event)
    • BLOCK_JOB_READY (Event)
    • BLOCK_JOB_PENDING (Event)
    • PreallocMode (Enum)
    • BLOCK_WRITE_THRESHOLD (Event)
    • block-set-write-threshold (Command)
    • x-blockdev-change (Command)
    • x-blockdev-set-iothread (Command)
    • QuorumOpType (Enum)
    • QUORUM_FAILURE (Event)
    • QUORUM_REPORT_BAD (Event)
    • BlockdevSnapshotInternal (Object)
    • blockdev-snapshot-internal-sync (Command)
    • blockdev-snapshot-delete-internal-sync (Command)
    • Block device exports
  • Character devices
    • ChardevInfo (Object)
    • query-chardev (Command)
    • ChardevBackendInfo (Object)
    • query-chardev-backends (Command)
    • DataFormat (Enum)
    • ringbuf-write (Command)
    • ringbuf-read (Command)
    • ChardevCommon (Object)
    • ChardevFile (Object)
    • ChardevHostdev (Object)
    • ChardevSocket (Object)
    • ChardevUdp (Object)
    • ChardevMux (Object)
    • ChardevStdio (Object)
    • ChardevSpiceChannel (Object)
    • ChardevSpicePort (Object)
    • ChardevVC (Object)
    • ChardevRingbuf (Object)
    • ChardevQemuVDAgent (Object)
    • ChardevBackendKind (Enum)
    • ChardevFileWrapper (Object)
    • ChardevHostdevWrapper (Object)
    • ChardevSocketWrapper (Object)
    • ChardevUdpWrapper (Object)
    • ChardevCommonWrapper (Object)
    • ChardevMuxWrapper (Object)
    • ChardevStdioWrapper (Object)
    • ChardevSpiceChannelWrapper (Object)
    • ChardevSpicePortWrapper (Object)
    • ChardevQemuVDAgentWrapper (Object)
    • ChardevVCWrapper (Object)
    • ChardevRingbufWrapper (Object)
    • ChardevBackend (Object)
    • ChardevReturn (Object)
    • chardev-add (Command)
    • chardev-change (Command)
    • chardev-remove (Command)
    • chardev-send-break (Command)
    • VSERPORT_CHANGE (Event)
  • QMP monitor control
    • qmp_capabilities (Command)
    • QMPCapability (Enum)
    • VersionTriple (Object)
    • VersionInfo (Object)
    • query-version (Command)
    • CommandInfo (Object)
    • query-commands (Command)
    • quit (Command)
    • MonitorMode (Enum)
    • MonitorOptions (Object)
  • QMP introspection
    • query-qmp-schema (Command)
    • SchemaMetaType (Enum)
    • SchemaInfo (Object)
    • SchemaInfoBuiltin (Object)
    • JSONType (Enum)
    • SchemaInfoEnum (Object)
    • SchemaInfoEnumMember (Object)
    • SchemaInfoArray (Object)
    • SchemaInfoObject (Object)
    • SchemaInfoObjectMember (Object)
    • SchemaInfoObjectVariant (Object)
    • SchemaInfoAlternate (Object)
    • SchemaInfoAlternateMember (Object)
    • SchemaInfoCommand (Object)
    • SchemaInfoEvent (Object)
  • User authorization
    • QAuthZListPolicy (Enum)
    • QAuthZListFormat (Enum)
    • QAuthZListRule (Object)
    • AuthZListProperties (Object)
    • AuthZListFileProperties (Object)
    • AuthZPAMProperties (Object)
    • AuthZSimpleProperties (Object)
  • QEMU Object Model (QOM)
    • ObjectPropertyInfo (Object)
    • qom-list (Command)
    • qom-get (Command)
    • qom-set (Command)
    • ObjectTypeInfo (Object)
    • qom-list-types (Command)
    • qom-list-properties (Command)
    • CanHostSocketcanProperties (Object)
    • ColoCompareProperties (Object)
    • CryptodevBackendProperties (Object)
    • CryptodevVhostUserProperties (Object)
    • DBusVMStateProperties (Object)
    • NetfilterInsert (Enum)
    • NetfilterProperties (Object)
    • FilterBufferProperties (Object)
    • FilterDumpProperties (Object)
    • FilterMirrorProperties (Object)
    • FilterRedirectorProperties (Object)
    • FilterRewriterProperties (Object)
    • InputBarrierProperties (Object)
    • InputLinuxProperties (Object)
    • IothreadProperties (Object)
    • MemoryBackendProperties (Object)
    • MemoryBackendFileProperties (Object)
    • MemoryBackendMemfdProperties (Object)
    • MemoryBackendEpcProperties (Object)
    • PrManagerHelperProperties (Object)
    • QtestProperties (Object)
    • RemoteObjectProperties (Object)
    • RngProperties (Object)
    • RngEgdProperties (Object)
    • RngRandomProperties (Object)
    • SevGuestProperties (Object)
    • ObjectType (Enum)
    • ObjectOptions (Object)
    • object-add (Command)
    • object-del (Command)
  • Transactions
    • Abort (Object)
    • ActionCompletionMode (Enum)
    • TransactionActionKind (Enum)
    • AbortWrapper (Object)
    • BlockDirtyBitmapAddWrapper (Object)
    • BlockDirtyBitmapWrapper (Object)
    • BlockDirtyBitmapMergeWrapper (Object)
    • BlockdevBackupWrapper (Object)
    • BlockdevSnapshotWrapper (Object)
    • BlockdevSnapshotInternalWrapper (Object)
    • BlockdevSnapshotSyncWrapper (Object)
    • DriveBackupWrapper (Object)
    • TransactionAction (Object)
    • TransactionProperties (Object)
    • transaction (Command)

An enumeration of the I/O operation types

read

read operation

write

write operation

2.1

An enumeration of three options: on, off, and auto

auto

QEMU selects the value between on and off

on

Enabled

off

Disabled

2.2

An enumeration of three values: on, off, and split

on

Enabled

off

Disabled

split

Mixed

2.6

A fat type wrapping ’str’, to be embedded in lists.

*str: string*

Not documented

1.2

This is a string value or the explicit lack of a string (null pointer in C). Intended for cases when ’optional absent’ already has a different meaning.

*s: string*

the string value

*n: null*

no string value

2.10

An enumeration of options for specifying a PCI BAR

off

The specified feature is disabled

auto

The PCI BAR for the feature is automatically selected

bar0

PCI BAR0 is used for the feature

bar1

PCI BAR1 is used for the feature

bar2

PCI BAR2 is used for the feature

bar3

PCI BAR3 is used for the feature

bar4

PCI BAR4 is used for the feature

bar5

PCI BAR5 is used for the feature

2.12

An enumeration of PCIe link speeds in units of GT/s

2_5

2.5GT/s

5

5.0GT/s

8

8.0GT/s

16

16.0GT/s

4.0

An enumeration of PCIe link width

1

x1

2

x2

4

x4

8

x8

12

x12

16

x16

32

x32

4.0

Host memory policy types

default

restore default policy, remove any nondefault policy

preferred

set the preferred host nodes for allocation

bind

a strict policy that restricts memory allocation to the host nodes specified

interleave

memory allocations are interleaved across the set of host nodes specified

2.1

Indicates whether a netfilter is attached to a netdev’s transmit queue or receive queue or both.

all

the filter is attached both to the receive and the transmit queue of the netdev (default).

rx

the filter is attached to the receive queue of the netdev, where it will receive packets sent to the netdev.

tx

the filter is attached to the transmit queue of the netdev, where it will receive packets sent by the netdev.

2.5

Keys to toggle input-linux between host and guest.

ctrl-ctrl

Not documented

alt-alt

Not documented

shift-shift

Not documented

meta-meta

Not documented

scrolllock

Not documented

ctrl-scrolllock

Not documented

4.0

*human-readable-text: string*

Formatted output intended for humans.

6.2

The type of network endpoint that will be using the credentials. Most types of credential require different setup / structures depending on whether they will be used in a server versus a client.

client

the network endpoint is acting as the client

server

the network endpoint is acting as the server

2.5

The data format that the secret is provided in

raw

raw bytes. When encoded in JSON only valid UTF-8 sequences can be used

base64

arbitrary base64 encoded binary data

2.6

The supported algorithms for computing content digests

md5

MD5. Should not be used in any new code, legacy compat only

sha1

SHA-1. Should not be used in any new code, legacy compat only

sha224

SHA-224. (since 2.7)

sha256

SHA-256. Current recommended strong hash.

sha384

SHA-384. (since 2.7)

sha512

SHA-512. (since 2.7)

ripemd160

RIPEMD-160. (since 2.7)

2.6

The supported algorithms for content encryption ciphers

aes-128

AES with 128 bit / 16 byte keys

aes-192

AES with 192 bit / 24 byte keys

aes-256

AES with 256 bit / 32 byte keys

des

DES with 56 bit / 8 byte keys. Do not use except in VNC. (since 6.1)

3des

3DES(EDE) with 192 bit / 24 byte keys (since 2.9)

cast5-128

Cast5 with 128 bit / 16 byte keys

serpent-128

Serpent with 128 bit / 16 byte keys

serpent-192

Serpent with 192 bit / 24 byte keys

serpent-256

Serpent with 256 bit / 32 byte keys

twofish-128

Twofish with 128 bit / 16 byte keys

twofish-192

Twofish with 192 bit / 24 byte keys

twofish-256

Twofish with 256 bit / 32 byte keys

2.6

The supported modes for content encryption ciphers

ecb

Electronic Code Book

cbc

Cipher Block Chaining

xts

XEX with tweaked code book and ciphertext stealing

ctr

Counter (Since 2.8)

2.6

The supported algorithms for generating initialization vectors for full disk encryption. The ’plain’ generator should not be used for disks with sector numbers larger than 2^32, except where compatibility with pre-existing Linux dm-crypt volumes is required.

plain

64-bit sector number truncated to 32-bits

plain64

64-bit sector number

essiv

64-bit sector number encrypted with a hash of the encryption key

2.6

The supported full disk encryption formats

qcow

QCow/QCow2 built-in AES-CBC encryption. Use only for liberating data from old images.

luks

LUKS encryption format. Recommended for new images

2.6

The common options that apply to all full disk encryption formats

*format: QCryptoBlockFormat*

the encryption format

2.6

The options that apply to QCow/QCow2 AES-CBC encryption format

*key-secret: string (optional)*

the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.

2.6

The options that apply to LUKS encryption format

*key-secret: string (optional)*

the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.

2.6

The options that apply to LUKS encryption format initialization

*cipher-alg: QCryptoCipherAlgorithm (optional)*

the cipher algorithm for data encryption Currently defaults to ’aes-256’.

*cipher-mode: QCryptoCipherMode (optional)*

the cipher mode for data encryption Currently defaults to ’xts’

*ivgen-alg: QCryptoIVGenAlgorithm (optional)*

the initialization vector generator Currently defaults to ’plain64’

*ivgen-hash-alg: QCryptoHashAlgorithm (optional)*

the initialization vector generator hash Currently defaults to ’sha256’

*hash-alg: QCryptoHashAlgorithm (optional)*

the master key hash algorithm Currently defaults to ’sha256’

*iter-time: int (optional)*

number of milliseconds to spend in PBKDF passphrase processing. Currently defaults to 2000. (since 2.8)

The members of QCryptoBlockOptionsLUKS

2.6

The options that are available for all encryption formats when opening an existing volume

The members of QCryptoBlockOptionsBase

(no term)

The members of *QCryptoBlockOptionsQCow when format is “qcow”* ::

(no term)

The members of *QCryptoBlockOptionsLUKS when format is “luks”* ::

2.6

The options that are available for all encryption formats when initializing a new volume

The members of QCryptoBlockOptionsBase

(no term)

The members of *QCryptoBlockOptionsQCow when format is “qcow”* ::

(no term)

The members of *QCryptoBlockCreateOptionsLUKS when format is “luks”* ::

2.6

The common information that applies to all full disk encryption formats

*format: QCryptoBlockFormat*

the encryption format

2.7

Information about the LUKS block encryption key slot options

*active: boolean*

whether the key slot is currently in use

*key-offset: int*

offset to the key material in bytes

*iters: int (optional)*

number of PBKDF2 iterations for key material

*stripes: int (optional)*

number of stripes for splitting key material

2.7

Information about the LUKS block encryption options

*cipher-alg: QCryptoCipherAlgorithm*

the cipher algorithm for data encryption

*cipher-mode: QCryptoCipherMode*

the cipher mode for data encryption

*ivgen-alg: QCryptoIVGenAlgorithm*

the initialization vector generator

*ivgen-hash-alg: QCryptoHashAlgorithm (optional)*

the initialization vector generator hash

*hash-alg: QCryptoHashAlgorithm*

the master key hash algorithm

*payload-offset: int*

offset to the payload data in bytes

*master-key-iters: int*

number of PBKDF2 iterations for key material

*uuid: string*

unique identifier for the volume

*slots: array of QCryptoBlockInfoLUKSSlot*

information about each key slot

2.7

Information about the block encryption options

The members of QCryptoBlockInfoBase

(no term)

The members of *QCryptoBlockInfoLUKS when format is “luks”* ::

2.7

Defines state of keyslots that are affected by the update

active

The slots contain the given password and marked as active

inactive

The slots are erased (contain garbage) and marked as inactive

5.1

This struct defines the update parameters that activate/de-activate set of keyslots

*state: QCryptoBlockLUKSKeyslotState*

the desired state of the keyslots

*new-secret: string (optional)*

The ID of a QCryptoSecret object providing the password to be written into added active keyslots

*old-secret: string (optional)*

Optional (for deactivation only) If given will deactivate all keyslots that match password located in QCryptoSecret with this ID

*iter-time: int (optional)*

Optional (for activation only) Number of milliseconds to spend in PBKDF passphrase processing for the newly activated keyslot. Currently defaults to 2000.

*keyslot: int (optional)*

Optional. ID of the keyslot to activate/deactivate. For keyslot activation, keyslot should not be active already (this is unsafe to update an active keyslot), but possible if ’force’ parameter is given. If keyslot is not given, first free keyslot will be written.

For keyslot deactivation, this parameter specifies the exact keyslot to deactivate

*secret: string (optional)*

Optional. The ID of a QCryptoSecret object providing the password to use to retrieve current master key. Defaults to the same secret that was used to open the image

Since 5.1

The options that are available for all encryption formats when amending encryption settings

The members of QCryptoBlockOptionsBase

(no term)

The members of *QCryptoBlockAmendOptionsLUKS when format is “luks”* ::

5.1

Properties for objects of classes derived from secret-common.

*loaded: boolean (optional)*

if true, the secret is loaded immediately when applying this option and will probably fail when processing the next option. Don’t use; only provided for compatibility. (default: false)

*format: QCryptoSecretFormat (optional)*

the data format that the secret is provided in (default: raw)

*keyid: string (optional)*

the name of another secret that should be used to decrypt the provided data. If not present, the data is assumed to be unencrypted.

*iv: string (optional)*

the random initialization vector used for encryption of this particular secret. Should be a base64 encrypted string of the 16-byte IV. Mandatory if keyid is given. Ignored if keyid is absent.

deprecated

Member loaded is deprecated. Setting true doesn’t make sense, and false is already the default.

2.6

Properties for secret objects.

Either data or file must be provided, but not both.

*data: string (optional)*

the associated with the secret from

*file: string (optional)*

the filename to load the data associated with the secret from

The members of SecretCommonProperties

2.6

Properties for secret_keyring objects.

*serial: int*

serial number that identifies a key to get from the kernel

The members of SecretCommonProperties

5.1

Properties for objects of classes derived from tls-creds.

*verify-peer: boolean (optional)*

if true the peer credentials will be verified once the handshake is completed. This is a no-op for anonymous credentials. (default: true)

*dir: string (optional)*

the path of the directory that contains the credential files

*endpoint: QCryptoTLSCredsEndpoint (optional)*

whether the QEMU network backend that uses the credentials will be acting as a client or as a server (default: client)

*priority: string (optional)*

a gnutls priority string as described at https://gnutls.org/manual/html_node/Priority-Strings.html

2.5

Properties for tls-creds-anon objects.

*loaded: boolean (optional)*

if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)

The members of TlsCredsProperties

deprecated

Member loaded is deprecated. Setting true doesn’t make sense, and false is already the default.

2.5

Properties for tls-creds-psk objects.

*loaded: boolean (optional)*

if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)

*username: string (optional)*

the username which will be sent to the server. For clients only. If absent, “qemu” is sent and the property will read back as an empty string.

The members of TlsCredsProperties

deprecated

Member loaded is deprecated. Setting true doesn’t make sense, and false is already the default.

3.0

Properties for tls-creds-x509 objects.

*loaded: boolean (optional)*

if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)

*sanity-check: boolean (optional)*

if true, perform some sanity checks before using the credentials (default: true)

*passwordid: string (optional)*

For the server-key.pem and client-key.pem files which contain sensitive private keys, it is possible to use an encrypted version by providing the passwordid parameter. This provides the ID of a previously created secret object containing the password for decryption.

The members of TlsCredsProperties

deprecated

Member loaded is deprecated. Setting true doesn’t make sense, and false is already the default.

2.5

Type of a background job.

commit

block commit job type, see “block-commit”

stream

block stream job type, see “block-stream”

mirror

drive mirror job type, see “drive-mirror”

backup

drive backup job type, see “drive-backup”

create

image creation job type, see “blockdev-create” (since 3.0)

amend

image options amend job type, see “x-blockdev-amend” (since 5.1)

snapshot-load

snapshot load job type, see “snapshot-load” (since 6.0)

snapshot-save

snapshot save job type, see “snapshot-save” (since 6.0)

snapshot-delete

snapshot delete job type, see “snapshot-delete” (since 6.0)

1.7

Indicates the present state of a given job in its lifetime.

undefined

Erroneous, default state. Should not ever be visible.

created

The job has been created, but not yet started.

running

The job is currently running.

paused

The job is running, but paused. The pause may be requested by either the QMP user or by internal processes.

ready

The job is running, but is ready for the user to signal completion. This is used for long-running jobs like mirror that are designed to run indefinitely.

standby

The job is ready, but paused. This is nearly identical to paused. The job may return to ready or otherwise be canceled.

waiting

The job is waiting for other jobs in the transaction to converge to the waiting state. This status will likely not be visible for the last job in a transaction.

pending

The job has finished its work, but has finalization steps that it needs to make prior to completing. These changes will require manual intervention via job-finalize if auto-finalize was set to false. These pending changes may still fail.

aborting

The job is in the process of being aborted, and will finish with an error. The job will afterwards report that it is concluded. This status may not be visible to the management process.

concluded

The job has finished all work. If auto-dismiss was set to false, the job will remain in the query list until it is dismissed via job-dismiss.

null

The job is in the process of being dismantled. This state should not ever be visible externally.

2.12

Represents command verbs that can be applied to a job.

cancel

see job-cancel

pause

see job-pause

resume

see job-resume

set-speed

see block-job-set-speed

complete

see job-complete

dismiss

see job-dismiss

finalize

see job-finalize

2.12

Emitted when a job transitions to a different status.

*id: string*

The job identifier

*status: JobStatus*

The new job status

3.0

Pause an active job.

This command returns immediately after marking the active job for pausing. Pausing an already paused job is an error.

The job will pause as soon as possible, which means transitioning into the PAUSED state if it was RUNNING, or into STANDBY if it was READY. The corresponding JOB_STATUS_CHANGE event will be emitted.

Cancelling a paused job automatically resumes it.

*id: string*

The job identifier.

3.0

Resume a paused job.

This command returns immediately after resuming a paused job. Resuming an already running job is an error.

id : The job identifier.

*id: string*

Not documented

3.0

Instruct an active background job to cancel at the next opportunity. This command returns immediately after marking the active job for cancellation.

The job will cancel as soon as possible and then emit a JOB_STATUS_CHANGE event. Usually, the status will change to ABORTING, but it is possible that a job successfully completes (e.g. because it was almost done and there was no opportunity to cancel earlier than completing the job) and transitions to PENDING instead.

*id: string*

The job identifier.

3.0

Manually trigger completion of an active job in the READY state.

*id: string*

The job identifier.

3.0

Deletes a job that is in the CONCLUDED state. This command only needs to be run explicitly for jobs that don’t have automatic dismiss enabled.

This command will refuse to operate on any job that has not yet reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that make use of JOB_READY event, job-cancel or job-complete will still need to be used as appropriate.

*id: string*

The job identifier.

3.0

Instructs all jobs in a transaction (or a single job if it is not part of any transaction) to finalize any graph changes and do any necessary cleanup. This command requires that all involved jobs are in the PENDING state.

For jobs in a transaction, instructing one job to finalize will force ALL jobs in the transaction to finalize, so it is only necessary to instruct a single member job to finalize.

*id: string*

The identifier of any job in the transaction, or of a job that is not part of any transaction.

3.0

Information about a job.

*id: string*

The job identifier

*type: JobType*

The kind of job that is being performed

*status: JobStatus*

Current job state/status

*current-progress: int*

Progress made until now. The unit is arbitrary and the value can only meaningfully be used for the ratio of current-progress to total-progress. The value is monotonically increasing.

*total-progress: int*

Estimated current-progress value at the completion of the job. This value can arbitrarily change while the job is running, in both directions.

*error: string (optional)*

If this field is present, the job failed; if it is still missing in the CONCLUDED state, this indicates successful completion.

The value is a human-readable error message to describe the reason for the job failure. It should not be parsed by applications.

3.0

Return information about jobs.

a list with a JobInfo for each active job

3.0

The network address family

ipv4

IPV4 family

ipv6

IPV6 family

unix

unix socket

vsock

vsock family (since 2.8)

unknown

otherwise

2.1

*host: string*

host part of the address

*port: string*

port part of the address

Captures a socket address or address range in the Internet namespace.

*numeric: boolean (optional)*

true if the host/port are guaranteed to be numeric, false if name resolution should be attempted. Defaults to false. (Since 2.9)

*to: int (optional)*

If present, this is range of possible addresses, with port between port and to.

*ipv4: boolean (optional)*

whether to accept IPv4 addresses, default try both IPv4 and IPv6

*ipv6: boolean (optional)*

whether to accept IPv6 addresses, default try both IPv4 and IPv6

*keep-alive: boolean (optional)*

enable keep-alive when connecting to this socket. Not supported for passive sockets. (Since 4.2)

mptcp: boolean (optional) (If: HAVE_IPPROTO_MPTCP)

enable multi-path TCP. (Since 6.1)

The members of InetSocketAddressBase

1.3

Captures a socket address in the local (“Unix socket”) namespace.

*path: string*

filesystem path to use

abstract: boolean (optional) (If: CONFIG_LINUX)

if true, this is a Linux abstract socket address. path will be prefixed by a null byte, and optionally padded with null bytes. Defaults to false. (Since 5.1)

tight: boolean (optional) (If: CONFIG_LINUX)

if false, pad an abstract socket address with enough null bytes to make it fill struct sockaddr_un member sun_path. Defaults to true. (Since 5.1)

1.3

Captures a socket address in the vsock namespace.

*cid: string*

unique host identifier

*port: string*

port

string types are used to allow for possible future hostname or service resolution support.

2.8

*data: InetSocketAddress*

Not documented

1.3

*data: UnixSocketAddress*

Not documented

1.3

*data: VsockSocketAddress*

Not documented

2.8

*data: String*

Not documented

1.3

Captures the address of a socket, which could also be a named file descriptor

*type: SocketAddressType*

Not documented

(no term)

The members of *InetSocketAddressWrapper when type is “inet”* ::

(no term)

The members of *UnixSocketAddressWrapper when type is “unix”* ::

(no term)

The members of *VsockSocketAddressWrapper when type is “vsock”* ::

The members of *StringWrapper when type is “fd”*

This type is deprecated in favor of SocketAddress. The difference between SocketAddressLegacy and SocketAddress is that the latter is has fewer {} on the wire.

1.3

Available SocketAddress types

inet

Internet address

unix

Unix domain socket

vsock

VMCI address

fd

decimal is for file descriptor number, otherwise a file descriptor name. Named file descriptors are permitted in monitor commands, in combination with the ’getfd’ command. Decimal file descriptors are permitted at startup or other contexts where no monitor context is active.

2.9

Captures the address of a socket, which could also be a named file descriptor

*type: SocketAddressType*

Transport type

The members of *InetSocketAddress when type is “inet”*

The members of *UnixSocketAddress when type is “unix”*

The members of *VsockSocketAddress when type is “vsock”*

The members of *String when type is “fd”*

2.9

*id: string*

unique snapshot id

*name: string*

user chosen name

*vm-state-size: int*

size of the VM state

*date-sec: int*

UTC date of the snapshot in seconds

*date-nsec: int*

fractional part in nano seconds to be used with date-sec

*vm-clock-sec: int*

VM clock relative to boot in seconds

*vm-clock-nsec: int*

fractional part in nano seconds to be used with vm-clock-sec

*icount: int (optional)*

Current instruction count. Appears when execution record/replay is enabled. Used for “time-traveling” to match the moment in the recorded execution with the snapshots. This counter may be obtained through query-replay command (since 5.2)

1.3

*format: BlockdevQcow2EncryptionFormat*

The encryption format

2.10

The members of ImageInfoSpecificQCow2EncryptionBase

(no term)

The members of *QCryptoBlockInfoLUKS when format is “luks”* ::

2.10

*compat: string*

compatibility level

*data-file: string (optional)*

the filename of the external data file that is stored in the image and used as a default for opening the image (since: 4.0)

*data-file-raw: boolean (optional)*

True if the external data file must stay valid as a standalone (read-only) raw image without looking at qcow2 metadata (since: 4.0)

*extended-l2: boolean (optional)*

true if the image has extended L2 entries; only valid for compat >= 1.1 (since 5.2)

*lazy-refcounts: boolean (optional)*

on or off; only valid for compat >= 1.1

*corrupt: boolean (optional)*

true if the image has been marked corrupt; only valid for compat >= 1.1 (since 2.2)

*refcount-bits: int*

width of a refcount entry in bits (since 2.3)

(no term)

*encrypt: ImageInfoSpecificQCow2Encryption (optional)* :: details about encryption parameters; only set if image is encrypted (since 2.10)

*bitmaps: array of Qcow2BitmapInfo (optional)*

A list of qcow2 bitmap details (since 4.0)

*compression-type: Qcow2CompressionType*

the image cluster compression method (since 5.1)

1.7

*create-type: string*

The create type of VMDK image

*cid: int*

Content id of image

*parent-cid: int*

Parent VMDK image’s cid

*extents: array of ImageInfo*

List of extent files

1.7

• *encryption-format: RbdImageEncryptionFormat (optional)* :: Image encryption format

6.1

luks

Since 2.7

rbd

Since 6.1

qcow2

Not documented

vmdk

Not documented

1.7

*data: ImageInfoSpecificQCow2*

Not documented

1.7

*data: ImageInfoSpecificVmdk*

Not documented

6.1

*data: QCryptoBlockInfoLUKS*

Not documented

2.7

*data: ImageInfoSpecificRbd*

Not documented

6.1

A discriminated record of image format specific information structures.

*type: ImageInfoSpecificKind*

Not documented

(no term)

The members of *ImageInfoSpecificQCow2Wrapper when type is “qcow2”* ::

(no term)

The members of *ImageInfoSpecificVmdkWrapper when type is “vmdk”* ::

(no term)

The members of *ImageInfoSpecificLUKSWrapper when type is “luks”* ::

(no term)

The members of *ImageInfoSpecificRbdWrapper when type is “rbd”* ::

1.7

Information about a QEMU image file

*filename: string*

name of the image file

*format: string*

format of the image file

*virtual-size: int*

maximum capacity in bytes of the image

*actual-size: int (optional)*

actual size on disk in bytes of the image

*dirty-flag: boolean (optional)*

true if image is not cleanly closed

*cluster-size: int (optional)*

size of a cluster in bytes

*encrypted: boolean (optional)*

true if the image is encrypted

*compressed: boolean (optional)*

true if the image is compressed (Since 1.7)

*backing-filename: string (optional)*

name of the backing file

*full-backing-filename: string (optional)*

full path of the backing file

*backing-filename-format: string (optional)*

the format of the backing file

*snapshots: array of SnapshotInfo (optional)*

list of VM snapshots

*backing-image: ImageInfo (optional)*

info of the backing image (since 1.6)

*format-specific: ImageInfoSpecific (optional)*

structure supplying additional format-specific information (since 1.7)

1.3

Information about a QEMU image file check

*filename: string*

name of the image file checked

*format: string*

format of the image file checked

*check-errors: int*

number of unexpected errors occurred during check

*image-end-offset: int (optional)*

offset (in bytes) where the image ends, this field is present if the driver for the image format supports it

*corruptions: int (optional)*

number of corruptions found during the check if any

*leaks: int (optional)*

number of leaks found during the check if any

*corruptions-fixed: int (optional)*

number of corruptions fixed during the check if any

*leaks-fixed: int (optional)*

number of leaks fixed during the check if any

*total-clusters: int (optional)*

total number of clusters, this field is present if the driver for the image format supports it

*allocated-clusters: int (optional)*

total number of allocated clusters, this field is present if the driver for the image format supports it

*fragmented-clusters: int (optional)*

total number of fragmented clusters, this field is present if the driver for the image format supports it

*compressed-clusters: int (optional)*

total number of compressed clusters, this field is present if the driver for the image format supports it

1.4

Mapping information from a virtual block range to a host file range

*start: int*

virtual (guest) offset of the first byte described by this entry

*length: int*

the number of bytes of the mapped virtual range

*data: boolean*

reading the image will actually read data from a file (in particular, if offset is present this means that the sectors are not simply preallocated, but contain actual data in raw format)

*zero: boolean*

whether the virtual blocks read as zeroes

*depth: int*

number of layers (0 = top image, 1 = top image’s backing file, …, n - 1 = bottom image (where n is the number of images in the chain)) before reaching one for which the range is allocated

*present: boolean*

true if this layer provides the data, false if adding a backing layer could impact this region (since 6.1)

*offset: int (optional)*

if present, the image file stores the data for this range in raw format at the given (host) offset

*filename: string (optional)*

filename that is referred to by offset

2.6

Cache mode information for a block device

*writeback: boolean*

true if writeback mode is enabled

*direct: boolean*

true if the host page cache is bypassed (O_DIRECT)

*no-flush: boolean*

true if flush requests are ignored for the device

2.3

Information about the backing device for a block device.

*file: string*

the filename of the backing device

*node-name: string (optional)*

the name of the block driver node (Since 2.0)

*ro: boolean*

true if the backing device was open read-only

*drv: string*

the name of the block format used to open the backing device. As of 0.14 this can be: ’blkdebug’, ’bochs’, ’cloop’, ’cow’, ’dmg’, ’file’, ’file’, ’ftp’, ’ftps’, ’host_cdrom’, ’host_device’, ’http’, ’https’, ’luks’, ’nbd’, ’parallels’, ’qcow’, ’qcow2’, ’raw’, ’vdi’, ’vmdk’, ’vpc’, ’vvfat’ 2.2: ’archipelago’ added, ’cow’ dropped 2.3: ’host_floppy’ deprecated 2.5: ’host_floppy’ dropped 2.6: ’luks’ added 2.8: ’replication’ added, ’tftp’ dropped 2.9: ’archipelago’ dropped

*backing_file: string (optional)*

the name of the backing file (for copy-on-write)

*backing_file_depth: int*

number of files in the backing file chain (since: 1.2)

*encrypted: boolean*

true if the backing device is encrypted

*detect_zeroes: BlockdevDetectZeroesOptions*

detect and optimize zero writes (Since 2.1)

*bps: int*

total throughput limit in bytes per second is specified

*bps_rd: int*

read throughput limit in bytes per second is specified

*bps_wr: int*

write throughput limit in bytes per second is specified

*iops: int*

total I/O operations per second is specified

*iops_rd: int*

read I/O operations per second is specified

*iops_wr: int*

write I/O operations per second is specified

*image: ImageInfo*

the info of image used (since: 1.6)

*bps_max: int (optional)*

total throughput limit during bursts,

in bytes (Since 1.7)

*bps_rd_max: int (optional)*

read throughput limit during bursts,

in bytes (Since 1.7)

*bps_wr_max: int (optional)*

write throughput limit during bursts,

in bytes (Since 1.7)

*iops_max: int (optional)*

total I/O operations per second during bursts,

in bytes (Since 1.7)

*iops_rd_max: int (optional)*

read I/O operations per second during bursts,

in bytes (Since 1.7)

*iops_wr_max: int (optional)*

write I/O operations per second during bursts,

in bytes (Since 1.7)

*bps_max_length: int (optional)*

maximum length of the *bps_max burst*

period, in seconds. (Since 2.6)

*bps_rd_max_length: int (optional)*

maximum length of the bps_rd_max

burst period, in seconds. (Since 2.6)

*bps_wr_max_length: int (optional)*

maximum length of the bps_wr_max

burst period, in seconds. (Since 2.6)

*iops_max_length: int (optional)*

maximum length of the *iops burst*

period, in seconds. (Since 2.6)

*iops_rd_max_length: int (optional)*

maximum length of the iops_rd_max

burst period, in seconds. (Since 2.6)

*iops_wr_max_length: int (optional)*

maximum length of the iops_wr_max

burst period, in seconds. (Since 2.6)

*iops_size: int (optional)*

an I/O size in bytes (Since 1.7)

*group: string (optional)*

throttle group name (Since 2.4)

*cache: BlockdevCacheInfo*

the cache mode used for the block device (since: 2.3)

*write_threshold: int*

configured write threshold for the device. 0 if disabled. (Since 2.3)

*dirty-bitmaps: array of BlockDirtyInfo (optional)*

dirty bitmaps information (only present if node has one or more dirty bitmaps) (Since 4.2)

0.14

An enumeration of block device I/O status.

ok

The last I/O operation has succeeded

failed

The last I/O operation has failed

nospace

The last I/O operation has failed due to a no-space condition

1.0

Block dirty bitmap information.

*name: string (optional)*

the name of the dirty bitmap (Since 2.4)

*count: int*

number of dirty bytes according to the dirty bitmap

*granularity: int*

granularity of the dirty bitmap in bytes (since 1.4)

*recording: boolean*

true if the bitmap is recording new writes from the guest. Replaces active and disabled statuses. (since 4.0)

*busy: boolean*

true if the bitmap is in-use by some operation (NBD or jobs) and cannot be modified via QMP or used by another operation. Replaces locked and frozen statuses. (since 4.0)

*persistent: boolean*

true if the bitmap was stored on disk, is scheduled to be stored on disk, or both. (since 4.0)

*inconsistent: boolean (optional)*

true if this is a persistent bitmap that was improperly stored. Implies persistent to be true; recording and busy to be false. This bitmap cannot be used. To remove it, use block-dirty-bitmap-remove. (Since 4.0)

1.3

An enumeration of flags that a bitmap can report to the user.

in-use

This flag is set by any process actively modifying the qcow2 file, and cleared when the updated bitmap is flushed to the qcow2 image. The presence of this flag in an offline image means that the bitmap was not saved correctly after its last usage, and may contain inconsistent data.

auto

The bitmap must reflect all changes of the virtual disk by any application that would write to this qcow2 file.

4.0

Qcow2 bitmap information.

*name: string*

the name of the bitmap

*granularity: int*

granularity of the bitmap in bytes

*flags: array of Qcow2BitmapInfoFlags*

flags of the bitmap

4.0

Block latency histogram.

*boundaries: array of int*

list of interval boundary values in nanoseconds, all greater than zero and in ascending order. For example, the list [10, 50, 100] produces the following histogram intervals: [0, 10), [10, 50), [50, 100), [100, +inf).

*bins: array of int*

list of io request counts corresponding to histogram intervals. len(bins) = len(boundaries) + 1 For the example above, bins may be something like [3, 1, 5, 2], and corresponding histogram looks like:

#+begin_quote

      5|           *
      4|           *
      3| *         *
      2| *         *    *
      1| *    *    *    *
       +------------------
           10   50   100

#+end_quote

4.0

Block device information. This structure describes a virtual device and the backing device associated with it.

*device: string*

The device name associated with the virtual device.

*qdev: string (optional)*

The qdev ID, or if no ID is assigned, the QOM path of the block device. (since 2.10)

*type: string*

This field is returned only for compatibility reasons, it should not be used (always returns ’unknown’)

*removable: boolean*

True if the device supports removable media.

*locked: boolean*

True if the guest has locked this device from having its media removed

*tray_open: boolean (optional)*

True if the device’s tray is open (only present if it has a tray)

(no term)

*io-status: BlockDeviceIoStatus (optional)* :: BlockDeviceIoStatus. Only present if the device supports it and the VM is configured to stop on errors (supported device models: virtio-blk, IDE, SCSI except scsi-generic)

*inserted: BlockDeviceInfo (optional)*

BlockDeviceInfo describing the device if media is present

0.14

Image file size calculation information. This structure describes the size requirements for creating a new image file.

The size requirements depend on the new image file format. File size always equals virtual disk size for the ’raw’ format, even for sparse POSIX files. Compact formats such as ’qcow2’ represent unallocated and zero regions efficiently so file size may be smaller than virtual disk size.

The values are upper bounds that are guaranteed to fit the new image file. Subsequent modification, such as internal snapshot or further bitmap creation, may require additional space and is not covered here.

*required: int*

Size required for a new image file, in bytes, when copying just allocated guest-visible contents.

*fully-allocated: int*

Image file size, in bytes, once data has been written to all sectors, when copying just guest-visible contents.

*bitmaps: int (optional)*

Additional size required if all the top-level bitmap metadata in the source image were to be copied to the destination, present only when source and destination both support persistent bitmaps. (since 5.1)

2.10

Get a list of BlockInfo for all virtual block devices.

a list of BlockInfo describing each virtual block device. Filter nodes that were created implicitly are skipped over.

0.14

#+begin_quote

      -> { "execute": "query-block" }
      <- {
            "return":[
               {
                  "io-status": "ok",
                  "device":"ide0-hd0",
                  "locked":false,
                  "removable":false,
                  "inserted":{
                     "ro":false,
                     "drv":"qcow2",
                     "encrypted":false,
                     "file":"disks/test.qcow2",
                     "backing_file_depth":1,
                     "bps":1000000,
                     "bps_rd":0,
                     "bps_wr":0,
                     "iops":1000000,
                     "iops_rd":0,
                     "iops_wr":0,
                     "bps_max": 8000000,
                     "bps_rd_max": 0,
                     "bps_wr_max": 0,
                     "iops_max": 0,
                     "iops_rd_max": 0,
                     "iops_wr_max": 0,
                     "iops_size": 0,
                     "detect_zeroes": "on",
                     "write_threshold": 0,
                     "image":{
                        "filename":"disks/test.qcow2",
                        "format":"qcow2",
                        "virtual-size":2048000,
                        "backing_file":"base.qcow2",
                        "full-backing-filename":"disks/base.qcow2",
                        "backing-filename-format":"qcow2",
                        "snapshots":[
                           {
                              "id": "1",
                              "name": "snapshot1",
                              "vm-state-size": 0,
                              "date-sec": 10000200,
                              "date-nsec": 12,
                              "vm-clock-sec": 206,
                              "vm-clock-nsec": 30
                           }
                        ],
                        "backing-image":{
                            "filename":"disks/base.qcow2",
                            "format":"qcow2",
                            "virtual-size":2048000
                        }
                     }
                  },
                  "qdev": "ide_disk",
                  "type":"unknown"
               },
               {
                  "io-status": "ok",
                  "device":"ide1-cd0",
                  "locked":false,
                  "removable":true,
                  "qdev": "/machine/unattached/device[23]",
                  "tray_open": false,
                  "type":"unknown"
               },
               {
                  "device":"floppy0",
                  "locked":false,
                  "removable":true,
                  "qdev": "/machine/unattached/device[20]",
                  "type":"unknown"
               },
               {
                  "device":"sd0",
                  "locked":false,
                  "removable":true,
                  "type":"unknown"
               }
            ]
         }

#+end_quote

Statistics of a block device during a given interval of time.

*interval_length: int*

Interval used for calculating the statistics, in seconds.

*min_rd_latency_ns: int*

Minimum latency of read operations in the defined interval, in nanoseconds.

*min_wr_latency_ns: int*

Minimum latency of write operations in the defined interval, in nanoseconds.

*min_flush_latency_ns: int*

Minimum latency of flush operations in the defined interval, in nanoseconds.

*max_rd_latency_ns: int*

Maximum latency of read operations in the defined interval, in nanoseconds.

*max_wr_latency_ns: int*

Maximum latency of write operations in the defined interval, in nanoseconds.

*max_flush_latency_ns: int*

Maximum latency of flush operations in the defined interval, in nanoseconds.

*avg_rd_latency_ns: int*

Average latency of read operations in the defined interval, in nanoseconds.

*avg_wr_latency_ns: int*

Average latency of write operations in the defined interval, in nanoseconds.

*avg_flush_latency_ns: int*

Average latency of flush operations in the defined interval, in nanoseconds.

*avg_rd_queue_depth: number*

Average number of pending read operations in the defined interval.

*avg_wr_queue_depth: number*

Average number of pending write operations in the defined interval.

2.5

Statistics of a virtual block device or a block backing device.

*rd_bytes: int*

The number of bytes read by the device.

*wr_bytes: int*

The number of bytes written by the device.

*unmap_bytes: int*

The number of bytes unmapped by the device (Since 4.2)

*rd_operations: int*

The number of read operations performed by the device.

*wr_operations: int*

The number of write operations performed by the device.

*flush_operations: int*

The number of cache flush operations performed by the device (since 0.15)

*unmap_operations: int*

The number of unmap operations performed by the device (Since 4.2)

*rd_total_time_ns: int*

Total time spent on reads in nanoseconds (since 0.15).

*wr_total_time_ns: int*

Total time spent on writes in nanoseconds (since 0.15).

*flush_total_time_ns: int*

Total time spent on cache flushes in nanoseconds (since 0.15).

*unmap_total_time_ns: int*

Total time spent on unmap operations in nanoseconds (Since 4.2)

*wr_highest_offset: int*

The offset after the greatest byte written to the device. The intended use of this information is for growable sparse files (like qcow2) that are used on top of a physical device.

*rd_merged: int*

Number of read requests that have been merged into another request (Since 2.3).

*wr_merged: int*

Number of write requests that have been merged into another request (Since 2.3).

*unmap_merged: int*

Number of unmap requests that have been merged into another request (Since 4.2)

*idle_time_ns: int (optional)*

Time since the last I/O operation, in nanoseconds. If the field is absent it means that there haven’t been any operations yet (Since 2.5).

*failed_rd_operations: int*

The number of failed read operations performed by the device (Since 2.5)

*failed_wr_operations: int*

The number of failed write operations performed by the device (Since 2.5)

*failed_flush_operations: int*

The number of failed flush operations performed by the device (Since 2.5)

*failed_unmap_operations: int*

The number of failed unmap operations performed by the device (Since 4.2)

*invalid_rd_operations: int*

The number of invalid read operations

performed by the device (Since 2.5)

*invalid_wr_operations: int*

The number of invalid write operations performed by the device (Since 2.5)

*invalid_flush_operations: int*

The number of invalid flush operations performed by the device (Since 2.5)

*invalid_unmap_operations: int*

The number of invalid unmap operations performed by the device (Since 4.2)

*account_invalid: boolean*

Whether invalid operations are included in the last access statistics (Since 2.5)

*account_failed: boolean*

Whether failed operations are included in the latency and last access statistics (Since 2.5)

*timed_stats: array of BlockDeviceTimedStats*

Statistics specific to the set of previously defined intervals of time (Since 2.5)

(no term)

*rd_latency_histogram: BlockLatencyHistogramInfo (optional)* :: BlockLatencyHistogramInfo. (Since 4.0)

(no term)

*wr_latency_histogram: BlockLatencyHistogramInfo (optional)* :: BlockLatencyHistogramInfo. (Since 4.0)

(no term)

*flush_latency_histogram: BlockLatencyHistogramInfo (optional)* :: BlockLatencyHistogramInfo. (Since 4.0)

0.14

File driver statistics

*discard-nb-ok: int*

The number of successful discard operations performed by the driver.

*discard-nb-failed: int*

The number of failed discard operations performed by the driver.

*discard-bytes-ok: int*

The number of bytes discarded by the driver.

4.2

NVMe driver statistics

*completion-errors: int*

The number of completion errors.

*aligned-accesses: int*

The number of aligned accesses performed by the driver.

*unaligned-accesses: int*

The number of unaligned accesses performed by the driver.

5.2

Block driver specific statistics

*driver: BlockdevDriver*

Not documented

(no term)

The members of *BlockStatsSpecificFile when driver is “file”* ::

(no term)

The members of BlockStatsSpecificFile when driver is “host_device” (If: HAVE_HOST_BLOCK_DEVICE) ::

(no term)

The members of *BlockStatsSpecificNvme when driver is “nvme”* ::

4.2

Statistics of a virtual block device or a block backing device.

*device: string (optional)*

If the stats are for a virtual block device, the name corresponding to the virtual block device.

*node-name: string (optional)*

The node name of the device. (Since 2.3)

*qdev: string (optional)*

The qdev ID, or if no ID is assigned, the QOM path of the block device. (since 3.0)

*stats: BlockDeviceStats*

A BlockDeviceStats for the device.

*driver-specific: BlockStatsSpecific (optional)*

Optional driver-specific stats. (Since 4.2)

*parent: BlockStats (optional)*

This describes the file block device if it has one. Contains recursively the statistics of the underlying protocol (e.g. the host file for a qcow2 image). If there is no underlying protocol, this field is omitted

*backing: BlockStats (optional)*

This describes the backing block device if it has one. (Since 2.0)

0.14

Query the BlockStats for all virtual block devices.

*query-nodes: boolean (optional)*

If true, the command will query all the block nodes that have a node name, in a list which will include “parent” information, but not “backing”. If false or omitted, the behavior is as before - query all the device backends, recursively including their “parent” and “backing”. Filter nodes that were created implicitly are skipped over in this mode. (Since 2.3)

A list of BlockStats for each virtual block devices.

0.14

#+begin_quote

      -> { "execute": "query-blockstats" }
      <- {
            "return":[
               {
                  "device":"ide0-hd0",
                  "parent":{
                     "stats":{
                        "wr_highest_offset":3686448128,
                        "wr_bytes":9786368,
                        "wr_operations":751,
                        "rd_bytes":122567168,
                        "rd_operations":36772
                        "wr_total_times_ns":313253456
                        "rd_total_times_ns":3465673657
                        "flush_total_times_ns":49653
                        "flush_operations":61,
                        "rd_merged":0,
                        "wr_merged":0,
                        "idle_time_ns":2953431879,
                        "account_invalid":true,
                        "account_failed":false
                     }
                  },
                  "stats":{
                     "wr_highest_offset":2821110784,
                     "wr_bytes":9786368,
                     "wr_operations":692,
                     "rd_bytes":122739200,
                     "rd_operations":36604
                     "flush_operations":51,
                     "wr_total_times_ns":313253456
                     "rd_total_times_ns":3465673657
                     "flush_total_times_ns":49653,
                     "rd_merged":0,
                     "wr_merged":0,
                     "idle_time_ns":2953431879,
                     "account_invalid":true,
                     "account_failed":false
                  },
                  "qdev": "/machine/unattached/device[23]"
               },
               {
                  "device":"ide1-cd0",
                  "stats":{
                     "wr_highest_offset":0,
                     "wr_bytes":0,
                     "wr_operations":0,
                     "rd_bytes":0,
                     "rd_operations":0
                     "flush_operations":0,
                     "wr_total_times_ns":0
                     "rd_total_times_ns":0
                     "flush_total_times_ns":0,
                     "rd_merged":0,
                     "wr_merged":0,
                     "account_invalid":false,
                     "account_failed":false
                  },
                  "qdev": "/machine/unattached/device[24]"
               },
               {
                  "device":"floppy0",
                  "stats":{
                     "wr_highest_offset":0,
                     "wr_bytes":0,
                     "wr_operations":0,
                     "rd_bytes":0,
                     "rd_operations":0
                     "flush_operations":0,
                     "wr_total_times_ns":0
                     "rd_total_times_ns":0
                     "flush_total_times_ns":0,
                     "rd_merged":0,
                     "wr_merged":0,
                     "account_invalid":false,
                     "account_failed":false
                  },
                  "qdev": "/machine/unattached/device[16]"
               },
               {
                  "device":"sd0",
                  "stats":{
                     "wr_highest_offset":0,
                     "wr_bytes":0,
                     "wr_operations":0,
                     "rd_bytes":0,
                     "rd_operations":0
                     "flush_operations":0,
                     "wr_total_times_ns":0
                     "rd_total_times_ns":0
                     "flush_total_times_ns":0,
                     "rd_merged":0,
                     "wr_merged":0,
                     "account_invalid":false,
                     "account_failed":false
                  }
               }
            ]
         }

#+end_quote

An enumeration of possible behaviors for errors on I/O operations. The exact meaning depends on whether the I/O was initiated by a guest or by a block job

report

for guest operations, report the error to the guest; for jobs, cancel the job

ignore

ignore the error, only report a QMP event (BLOCK_IO_ERROR or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs retry the failing request later and may still complete successfully. The stream block job continues to stream and will complete with an error.

enospc

same as stop on ENOSPC, same as report otherwise.

stop

for guest operations, stop the virtual machine; for jobs, pause the job

auto

inherit the error handling policy of the backend (since: 2.7)

1.3

An enumeration of possible behaviors for the initial synchronization phase of storage mirroring.

top

copies data in the topmost image to the destination

full

copies data from all images to the destination

none

only copy data written from now on

incremental

only copy data described by the dirty bitmap. (since: 2.4)

bitmap

only copy data described by the dirty bitmap. (since: 4.2) Behavior on completion is determined by the BitmapSyncMode.

1.3

An enumeration of possible behaviors for the synchronization of a bitmap when used for data copy operations.

on-success

The bitmap is only synced when the operation is successful. This is the behavior always used for ’INCREMENTAL’ backups.

never

The bitmap is never synchronized with the operation, and is treated solely as a read-only manifest of blocks to copy.

always

The bitmap is always synchronized with the operation, regardless of whether or not the operation was successful.

4.2

An enumeration whose values tell the mirror block job when to trigger writes to the target.

background

copy data in background only.

write-blocking

when data is written to the source, write it (synchronously) to the target as well. In addition, data is copied in background just like in background mode.

3.0

Information about a long-running block device operation.

*type: string*

the job type (’stream’ for image streaming)

*device: string*

The job identifier. Originally the device name but other values are allowed since QEMU 2.7

*len: int*

Estimated offset value at the completion of the job. This value can arbitrarily change while the job is running, in both directions.

*offset: int*

Progress made until now. The unit is arbitrary and the value can only meaningfully be used for the ratio of offset to len. The value is monotonically increasing.

*busy: boolean*

false if the job is known to be in a quiescent state, with no pending I/O. Since 1.3.

*paused: boolean*

whether the job is paused or, if busy is true, will pause itself as soon as possible. Since 1.3.

*speed: int*

the rate limit, bytes per second

*io-status: BlockDeviceIoStatus*

the status of the job (since 1.3)

*ready: boolean*

true if the job may be completed (since 2.2)

*status: JobStatus*

Current job state/status (since 2.12)

*auto-finalize: boolean*

Job will finalize itself when PENDING, moving to the CONCLUDED state. (since 2.12)

*auto-dismiss: boolean*

Job will dismiss itself when CONCLUDED, moving to the NULL state and disappearing from the query list. (since 2.12)

*error: string (optional)*

Error information if the job did not complete successfully. Not set if the job completed successfully. (since 2.12.1)

1.1

Return information about long-running block device operations.

a list of BlockJobInfo for each active block job

1.1

Resize a block image while a guest is running.

Either device or node-name must be set but not both.

*device: string (optional)*

the name of the device to get the image resized

*node-name: string (optional)*

graph node name to get the image resized (Since 2.0)

*size: int*

new image size in bytes

• nothing on success
• If device is not a valid block device, DeviceNotFound

0.14

#+begin_quote

      -> { "execute": "block_resize",
           "arguments": { "device": "scratch", "size": 1073741824 } }
      <- { "return": {} }

#+end_quote

An enumeration that tells QEMU how to set the backing file path in a new image file.

existing

QEMU should look for an existing image file.

absolute-paths

QEMU should create a new image with absolute paths for the backing file. If there is no backing file available, the new image will not be backed either.

1.1

Either device or node-name must be set but not both.

*device: string (optional)*

the name of the device to take a snapshot of.

*node-name: string (optional)*

graph node name to generate the snapshot from (Since 2.0)

*snapshot-file: string*

the target of the new overlay image. If the file exists, or if it is a device, the overlay will be created in the existing file/device. Otherwise, a new file will be created.

*snapshot-node-name: string (optional)*

the graph node name of the new image (Since 2.0)

*format: string (optional)*

the format of the overlay image, default is ’qcow2’.

*mode: NewImageMode (optional)*

whether and how QEMU should create a new image, default is ’absolute-paths’.

*node: string*

device or node name that will have a snapshot taken.

*overlay: string*

reference to the existing block device that will become the overlay of node, as part of taking the snapshot. It must not have a current backing file (this can be achieved by passing “backing”: null to blockdev-add).

2.5

Optional parameters for backup. These parameters don’t affect functionality, but may significantly affect performance.

*use-copy-range: boolean (optional)*

Use copy offloading. Default false.

*max-workers: int (optional)*

Maximum number of parallel requests for the sustained background copying process. Doesn’t influence copy-before-write operations. Default 64.

*max-chunk: int (optional)*

Maximum request length for the sustained background copying process. Doesn’t influence copy-before-write operations. 0 means unlimited. If max-chunk is non-zero then it should not be less than job cluster size which is calculated as maximum of target image cluster size and 64k. Default 0.

6.0

*job-id: string (optional)*

identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)

*device: string*

the device name or node-name of a root node which should be copied.

*sync: MirrorSyncMode*

what parts of the disk image should be copied to the destination (all the disk, only the sectors allocated in the topmost image, from a dirty bitmap, or only new I/O).

*speed: int (optional)*

the maximum speed, in bytes per second. The default is 0, for unlimited.

*bitmap: string (optional)*

The name of a dirty bitmap to use. Must be present if sync is “bitmap” or “incremental”. Can be present if sync is “full” or “top”. Must not be present otherwise. (Since 2.4 (drive-backup), 3.1 (blockdev-backup))

*bitmap-mode: BitmapSyncMode (optional)*

Specifies the type of data the bitmap should contain after the operation concludes. Must be present if a bitmap was provided, Must NOT be present otherwise. (Since 4.2)

*compress: boolean (optional)*

true to compress data, if the target format supports it. (default: false) (since 2.8)

*on-source-error: BlockdevOnError (optional)*

the action to take on an error on the source, default ’report’. ’stop’ and ’enospc’ can only be used if the block device supports io-status (see BlockInfo).

*on-target-error: BlockdevOnError (optional)*

the action to take on an error on the target, default ’report’ (no limitations, since this applies to a different block device than device).

*auto-finalize: boolean (optional)*

When false, this job will wait in a PENDING state after it has finished its work, waiting for block-job-finalize before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 2.12)

*auto-dismiss: boolean (optional)*

When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits block-job-dismiss. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 2.12)

*filter-node-name: string (optional)*

the node name that should be assigned to the filter driver that the backup job inserts into the graph above node specified by drive. If this option is not given, a node name is autogenerated. (Since: 4.2)

*x-perf: BackupPerf (optional)*

Performance options. (Since 6.0)

unstable

Member x-perf is experimental.

on-source-error and on-target-error only affect background I/O. If an error occurs during a guest write request, the device’s rerror/werror actions will be used.

4.2

*target: string*

the target of the new image. If the file exists, or if it is a device, the existing file/device will be used as the new destination. If it does not exist, a new file will be created.

*format: string (optional)*

the format of the new destination, default is to probe if mode is ’existing’, else the format of the source

*mode: NewImageMode (optional)*

whether and how QEMU should create a new image, default is ’absolute-paths’.

The members of BackupCommon

1.6

*target: string*

the device name or node-name of the backup target node.

The members of BackupCommon

2.3

Takes a synchronous snapshot of a block device.

For the arguments, see the documentation of BlockdevSnapshotSync.

• nothing on success
• If device is not a valid block device, DeviceNotFound

0.14

#+begin_quote

      -> { "execute": "blockdev-snapshot-sync",
           "arguments": { "device": "ide-hd0",
                          "snapshot-file":
                          "/some/place/my-image",
                          "format": "qcow2" } }
      <- { "return": {} }

#+end_quote

Takes a snapshot of a block device.

Take a snapshot, by installing ’node’ as the backing image of ’overlay’. Additionally, if ’node’ is associated with a block device, the block device changes to using ’overlay’ as its new active image.

For the arguments, see the documentation of BlockdevSnapshot.

allow-write-only-overlay

If present, the check whether this operation is safe was relaxed so that it can be used to change backing file of a destination of a blockdev-mirror. (since 5.0)

2.5

#+begin_quote

      -> { "execute": "blockdev-add",
           "arguments": { "driver": "qcow2",
                          "node-name": "node1534",
                          "file": { "driver": "file",
                                    "filename": "hd1.qcow2" },
                          "backing": null } }

      <- { "return": {} }

      -> { "execute": "blockdev-snapshot",
           "arguments": { "node": "ide-hd0",
                          "overlay": "node1534" } }
      <- { "return": {} }

#+end_quote

Change the backing file in the image file metadata. This does not cause QEMU to reopen the image file to reparse the backing filename (it may, however, perform a reopen to change permissions from r/o -> r/w -> r/o, if needed). The new backing file string is written into the image file metadata, and the QEMU internal strings are updated.

*image-node-name: string*

The name of the block driver state node of the image to modify. The “device” argument is used to verify “image-node-name” is in the chain described by “device”.

*device: string*

The device name or node-name of the root node that owns image-node-name.

*backing-file: string*

The string to write as the backing file. This string is not validated, so care should be taken when specifying the string or the image chain may not be able to be reopened again.

• Nothing on success
• If “device” does not exist or cannot be determined, DeviceNotFound

2.1

Live commit of data from overlay image nodes into backing nodes - i.e., writes data between ’top’ and ’base’ into ’base’.

If top == base, that is an error. If top has no overlays on top of it, or if it is in use by a writer, the job will not be completed by itself. The user needs to complete the job with the block-job-complete command after getting the ready event. (Since 2.0)

If the base image is smaller than top, then the base image will be resized to be the same size as top. If top is smaller than the base image, the base will not be truncated. If you want the base image size to match the size of the smaller top, you can safely truncate it yourself once the commit operation successfully completes.

*job-id: string (optional)*

identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)

*device: string*

the device name or node-name of a root node

*base-node: string (optional)*

The node name of the backing image to write data into. If not specified, this is the deepest backing image. (since: 3.1)

*base: string (optional)*

Same as base-node, except that it is a file name rather than a node name. This must be the exact filename string that was used to open the node; other strings, even if addressing the same file, are not accepted

*top-node: string (optional)*

The node name of the backing image within the image chain which contains the topmost data to be committed down. If not specified, this is the active layer. (since: 3.1)

*top: string (optional)*

Same as top-node, except that it is a file name rather than a node name. This must be the exact filename string that was used to open the node; other strings, even if addressing the same file, are not accepted

*backing-file: string (optional)*

The backing file string to write into the overlay image of ’top’. If ’top’ does not have an overlay image, or if ’top’ is in use by a writer, specifying a backing file string is an error.

This filename is not validated. If a pathname string is such that it cannot be resolved by QEMU, that means that subsequent QMP or HMP commands must use node-names for the image in question, as filename lookup methods will fail.

If not specified, QEMU will automatically determine the backing file string to use, or error out if there is no obvious choice. Care should be taken when specifying the string, to specify a valid filename or protocol. (Since 2.1)

*speed: int (optional)*

the maximum speed, in bytes per second

*on-error: BlockdevOnError (optional)*

the action to take on an error. ’ignore’ means that the request should be retried. (default: report; Since: 5.0)

*filter-node-name: string (optional)*

the node name that should be assigned to the filter driver that the commit job inserts into the graph above top. If this option is not given, a node name is autogenerated. (Since: 2.9)

*auto-finalize: boolean (optional)*

When false, this job will wait in a PENDING state after it has finished its work, waiting for block-job-finalize before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 3.1)

*auto-dismiss: boolean (optional)*

When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits block-job-dismiss. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 3.1)

deprecated

Members base and top are deprecated. Use base-node and top-node instead.

• Nothing on success
• If device does not exist, DeviceNotFound
• Any other error returns a GenericError.

1.3

#+begin_quote

      -> { "execute": "block-commit",
           "arguments": { "device": "virtio0",
                          "top": "/tmp/snap1.qcow2" } }
      <- { "return": {} }

#+end_quote

Start a point-in-time copy of a block device to a new destination. The status of ongoing drive-backup operations can be checked with query-block-jobs where the BlockJobInfo.type field has the value ’backup’. The operation can be stopped before it has completed using the block-job-cancel command.

The members of DriveBackup

deprecated

This command is deprecated. Use blockdev-backup instead.

• nothing on success
• If device is not a valid block device, GenericError

1.6

#+begin_quote

      -> { "execute": "drive-backup",
           "arguments": { "device": "drive0",
                          "sync": "full",
                          "target": "backup.img" } }
      <- { "return": {} }

#+end_quote

Start a point-in-time copy of a block device to a new destination. The status of ongoing blockdev-backup operations can be checked with query-block-jobs where the BlockJobInfo.type field has the value ’backup’. The operation can be stopped before it has completed using the block-job-cancel command.

The members of BlockdevBackup

• nothing on success
• If device is not a valid block device, DeviceNotFound

2.3

#+begin_quote

      -> { "execute": "blockdev-backup",
           "arguments": { "device": "src-id",
                          "sync": "full",
                          "target": "tgt-id" } }
      <- { "return": {} }

#+end_quote

Get the named block driver list

*flat: boolean (optional)*

Omit the nested data about backing image (“backing-image” key) if true. Default is false (Since 5.0)

the list of BlockDeviceInfo

2.0

#+begin_quote

      -> { "execute": "query-named-block-nodes" }
      <- { "return": [ { "ro":false,
                         "drv":"qcow2",
                         "encrypted":false,
                         "file":"disks/test.qcow2",
                         "node-name": "my-node",
                         "backing_file_depth":1,
                         "bps":1000000,
                         "bps_rd":0,
                         "bps_wr":0,
                         "iops":1000000,
                         "iops_rd":0,
                         "iops_wr":0,
                         "bps_max": 8000000,
                         "bps_rd_max": 0,
                         "bps_wr_max": 0,
                         "iops_max": 0,
                         "iops_rd_max": 0,
                         "iops_wr_max": 0,
                         "iops_size": 0,
                         "write_threshold": 0,
                         "image":{
                            "filename":"disks/test.qcow2",
                            "format":"qcow2",
                            "virtual-size":2048000,
                            "backing_file":"base.qcow2",
                            "full-backing-filename":"disks/base.qcow2",
                            "backing-filename-format":"qcow2",
                            "snapshots":[
                               {
                                  "id": "1",
                                  "name": "snapshot1",
                                  "vm-state-size": 0,
                                  "date-sec": 10000200,
                                  "date-nsec": 12,
                                  "vm-clock-sec": 206,
                                  "vm-clock-nsec": 30
                               }
                            ],
                            "backing-image":{
                                "filename":"disks/base.qcow2",
                                "format":"qcow2",
                                "virtual-size":2048000
                            }
                         } } ] }

#+end_quote

block-backend

corresponds to BlockBackend

block-job

corresponds to BlockJob

block-driver

corresponds to BlockDriverState

4.0

*id: int*

Block graph node identifier. This id is generated only for x-debug-query-block-graph and does not relate to any other identifiers in Qemu.

*type: XDbgBlockGraphNodeType*

Type of graph node. Can be one of block-backend, block-job or block-driver-state.

*name: string*

Human readable name of the node. Corresponds to node-name for block-driver-state nodes; is not guaranteed to be unique in the whole graph (with block-jobs and block-backends).