•

Introduction

•

QMP errors

•

Common data types

•

Socket data types

•

VM run state

•

Cryptography

•

Background jobs

•

Block devices

Block core (VM unrelated)

•

Additional block stuff (VM related)

•

Block device exports

•

•

Dump guest memory

•

Net devices

•

eBPF Objects

•

Rocker switch device

•

TPM (trusted platform module) devices

•

Remote desktop

Spice

•

VNC

•

•

User authorization

•

Migration

•

Transactions

•

Tracing

•

Compatibility policy

•

QMP monitor control

•

QMP introspection

•

QEMU Object Model (QOM)

•

Device infrastructure (qdev)

•

Common machine types

•

Machines

•

Record/replay

•

Yank feature

•

Miscellanea

•

Audio

•

ACPI

•

PCI

•

Statistics

•

Virtio devices

•

VFIO devices

•

Cryptography devices

•

CXL devices

•

UEFI Variable Store

Values

•

GenericError -- this is used for errors that don't require a specific error class. This should be the default case for most errors

•

CommandNotFound -- the requested command has not been found

•

DeviceNotActive -- a device has failed to be become active

•

DeviceNotFound -- the requested device has not been found

•

KVMMissingCap -- the requested operation can't be fulfilled because a required KVM capability is missing

Values

•

read -- read operation

•

write -- write operation

Values

•

auto -- QEMU selects the value between on and off

•

on -- Enabled

•

off -- Disabled

Values

•

on -- Enabled

•

off -- Disabled

•

split -- Mixed

•

s ( string ) -- the string value

•

n ( null ) -- no string value

Values

•

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

Values

•

2_5 -- 2.5GT/s

•

5 -- 5.0GT/s

•

8 -- 8.0GT/s

•

16 -- 16.0GT/s

•

32 -- 32.0GT/s (since 9.0)

•

64 -- 64.0GT/s (since 9.0)

Values

•

1 -- x1

•

2 -- x2

•

4 -- x4

•

8 -- x8

•

12 -- x12

•

16 -- x16

•

32 -- x32

Values

•

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

Values

•

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.

Values

•

ctrl-ctrl -- left and right control key

•

alt-alt -- left and right alt key

•

shift-shift -- left and right shift key

•

meta-meta -- left and right meta key

•

scrolllock -- scroll lock key

•

ctrl-scrolllock -- either control key and scroll lock key

•

human-readable-text ( string ) -- Formatted output intended for humans.

Values

•

unspecified -- Endianness not specified

•

little -- Little endianness

•

big -- Big endianness

Values

•

ipv4 -- IPV4 family

•

ipv6 -- IPV6 family

•

unix -- unix socket

•

vsock -- vsock family (since 2.8)

•

unknown -- otherwise

•

host ( string ) -- host part of the address

•

port ( string ) -- port part of the address

•

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 ) -- enable multi-path TCP. (Since 6.1)

•

The members of InetSocketAddressBase .

•

path ( string ) -- filesystem path to use

•

abstract ( boolean , optional ) -- 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 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)

•

cid ( string ) -- unique host identifier

•

port ( string ) -- port

•

str ( string ) -- decimal is for file descriptor number, otherwise it's 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.

•

data ( InetSocketAddress ) -- internet domain socket address

•

data ( UnixSocketAddress ) -- UNIX domain socket address

•

data ( VsockSocketAddress ) -- VSOCK domain socket address

•

data ( FdSocketAddress ) -- file descriptor name or number

•

type ( SocketAddressType ) -- Transport type

•

When type is inet : The members of InetSocketAddressWrapper .

•

When type is unix : The members of UnixSocketAddressWrapper .

•

When type is vsock : The members of VsockSocketAddressWrapper .

•

When type is fd : The members of FdSocketAddressWrapper .

Values

•

inet -- Internet address

•

unix -- Unix domain socket

•

vsock -- VMCI address

•

fd -- Socket file descriptor

•

type ( SocketAddressType ) -- Transport type

•

When type is inet : The members of InetSocketAddress .

•

When type is unix : The members of UnixSocketAddress .

•

When type is vsock : The members of VsockSocketAddress .

•

When type is fd : The members of FdSocketAddress .

Values

•

debug -- QEMU is running on a debugger

•

finish-migrate -- guest is paused to finish the migration process

•

inmigrate -- guest is paused waiting for an incoming migration. Note that this state does not tell whether the machine will start at the end of the migration. This depends on the command-line -S option and any invocation of 'stop' or 'cont' that has happened since QEMU was started.

•

internal-error -- An internal error that prevents further guest execution has occurred

•

io-error -- the last IOP has failed and the device is configured to pause on I/O errors

•

paused -- guest has been paused via the 'stop' command

•

postmigrate -- guest is paused following a successful 'migrate'

•

prelaunch -- QEMU was started with -S and guest has not started

•

restore-vm -- guest is paused to restore VM state

•

running -- guest is actively running

•

save-vm -- guest is paused to save the VM state

•

shutdown -- guest is shut down (and -no-shutdown is in use)

•

suspended -- guest is suspended (ACPI S3)

•

watchdog -- the watchdog action is configured to pause and has been triggered

•

guest-panicked -- guest has been panicked as a result of guest OS panic

•

colo -- guest is paused to save/restore VM state under colo checkpoint, VM can not get into this state unless colo capability is enabled for migration. (since 2.8)

Values

•

none -- No shutdown request pending

•

host-error -- An error prevents further use of guest

•

host-qmp-quit -- Reaction to the QMP command 'quit'

•

host-qmp-system-reset -- Reaction to the QMP command 'system_reset'

•

host-signal -- Reaction to a signal, such as SIGINT

•

host-ui -- Reaction to a UI event, like window close

•

guest-shutdown -- Guest shutdown/suspend request, via ACPI or other hardware-specific means

•

guest-reset -- Guest reset request, and command line turns that into a shutdown

•

guest-panic -- Guest panicked, and command line turns that into a shutdown

•

subsystem-reset -- Partial guest reset that does not trigger QMP events and ignores --no-reboot. This is useful for sanitizing hypercalls on s390 that are used during kexec/kdump/boot

•

snapshot-load -- A snapshot is being loaded by the record & replay subsystem. This value is used only within QEMU. It doesn't occur in QMP. (since 7.2)

•

running ( boolean ) -- true if all VCPUs are runnable, false if not runnable

•

status ( RunState ) -- the virtual machine RunState

Return

StatusInfo -- StatusInfo reflecting the VM

•

guest ( boolean ) -- If true, the shutdown was triggered by a guest request (such as a guest-initiated ACPI shutdown request or other hardware-specific action) rather than a host request (such as sending qemu a SIGINT). (since 2.10)

•

reason ( ShutdownCause ) -- The ShutdownCause which resulted in the SHUTDOWN. (since 4.0)

•

guest ( boolean ) -- If true, the reset was triggered by a guest request (such as a guest-initiated ACPI reboot request or other hardware-specific action) rather than a host request (such as the QMP command system_reset). (since 2.10)

•

reason ( ShutdownCause ) -- The ShutdownCause of the RESET. (since 4.0)

•

action ( WatchdogAction ) -- action that has been taken

Values

•

reset -- system resets

•

shutdown -- system shutdown, note that it is similar to powerdown , which tries to set to system status and notify guest

•

poweroff -- system poweroff, the emulator program exits

•

pause -- system pauses, similar to stop

•

debug -- system enters debug state

•

none -- nothing is done

•

inject-nmi -- a non-maskable interrupt is injected into the first VCPU (all VCPUS on x86) (since 2.4)

Values

•

reset -- Reset the VM

•

shutdown -- Shutdown the VM and exit, according to the shutdown action

Values

•

poweroff -- Shutdown the VM and exit

•

pause -- pause the VM

Values

•

none -- Continue VM execution

•

pause -- Pause the VM

•

shutdown -- Shutdown the VM and exit, according to the shutdown action

•

exit-failure -- Shutdown the VM and exit with nonzero status (since 7.1)

•

action ( WatchdogAction ) -- WatchdogAction action taken when watchdog timer expires.

•

reboot ( RebootAction , optional ) -- RebootAction action taken on guest reboot.

•

shutdown ( ShutdownAction , optional ) -- ShutdownAction action taken on guest shutdown.

•

panic ( PanicAction , optional ) -- PanicAction action taken on guest panic.

•

watchdog ( WatchdogAction , optional ) -- WatchdogAction action taken when watchdog timer expires.

•

action ( GuestPanicAction ) -- action that has been taken, currently always "pause"

•

info ( GuestPanicInformation , optional ) -- information about a panic (since 2.9)

•

action ( GuestPanicAction ) -- action that has been taken, currently always "run"

•

info ( GuestPanicInformation , optional ) -- information about a panic

Values

•

pause -- system pauses

•

poweroff -- system powers off (since 2.8)

•

run -- system continues to run (since 5.0)

Values

•

hyper-v -- hyper-v guest panic information type

•

s390 -- s390 guest panic information type (Since: 2.12)

•

type ( GuestPanicInformationType ) -- Crash type that defines the hypervisor specific information

•

When type is hyper-v : The members of GuestPanicInformationHyperV .

•

When type is s390 : The members of GuestPanicInformationS390 .

•

arg1 ( int ) -- for Windows, STOP code for the guest crash. For Linux, an error code.

•

arg2 ( int ) -- for Windows, first argument of the STOP. For Linux, the guest OS ID, which has the kernel version in bits 16-47 and 0x8100 in bits 48-63.

•

arg3 ( int ) -- for Windows, second argument of the STOP. For Linux, the program counter of the guest.

•

arg4 ( int ) -- for Windows, third argument of the STOP. For Linux, the RAX register (x86) or the stack pointer (aarch64) of the guest.

•

arg5 ( int ) -- for Windows, fourth argument of the STOP. For x86 Linux, the stack pointer of the guest.

Values

•

unknown -- no crash reason was set

•

disabled-wait -- the CPU has entered a disabled wait state

•

extint-loop -- clock comparator or cpu timer interrupt with new PSW enabled for external interrupts

•

pgmint-loop -- program interrupt with BAD new PSW

•

opint-loop -- operation exception interrupt with invalid code at the program interrupt new PSW

•

core ( int ) -- core id of the CPU that crashed

•

psw-mask ( int ) -- control fields of guest PSW

•

psw-addr ( int ) -- guest instruction address

•

reason ( S390CrashReason ) -- guest crash reason

•

recipient ( MemoryFailureRecipient ) -- recipient is defined as MemoryFailureRecipient .

•

action ( MemoryFailureAction ) -- action that has been taken.

•

flags ( MemoryFailureFlags ) -- flags for MemoryFailureAction.

Values

•

hypervisor -- memory failure at QEMU process address space. (none guest memory, but used by QEMU itself).

•

guest -- memory failure at guest memory,

Values

•

ignore -- the memory failure could be ignored. This will only be the case for action-optional failures.

•

inject -- memory failure occurred in guest memory, the guest enabled MCE handling mechanism, and QEMU could inject the MCE into the guest successfully.

•

fatal -- the failure is unrecoverable. This occurs for action-required failures if the recipient is the hypervisor; QEMU will exit.

•

reset -- the failure is unrecoverable but confined to the guest. This occurs if the recipient is a guest guest which is not ready to handle memory failures.

•

action-required ( boolean ) -- whether a memory failure event is action-required or action-optional (e.g. a failure during memory scrub).

•

recursive ( boolean ) -- whether the failure occurred while the previous failure was still in progress.

Values

•

run -- enable the feature, do nothing and continue if the notify VM exit happens.

•

internal-error -- enable the feature, raise a internal error if the notify VM exit happens.

•

disable -- disable the feature.

Values

•

client -- the network endpoint is acting as the client

•

server -- the network endpoint is acting as the server

Values

•

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

•

base64 -- arbitrary base64 encoded binary data

Values

•

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)

•

sm3 -- SM3. (since 9.2.0)

Values

•

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

•

sm4 -- SM4 with 128 bit / 16 byte keys (since 9.0)

Values

•

ecb -- Electronic Code Book

•

cbc -- Cipher Block Chaining

•

xts -- XEX with tweaked code book and ciphertext stealing

•

ctr -- Counter (Since 2.8)

Values

•

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

Values

•

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

•

luks -- LUKS encryption format. Recommended for new images

•

format ( QCryptoBlockFormat ) -- the encryption format

•

key-secret ( string , optional ) -- the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.

•

key-secret ( string , optional ) -- the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.

•

cipher-alg ( QCryptoCipherAlgo , 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 ( QCryptoIVGenAlgo , optional ) -- the initialization vector generator Currently defaults to 'plain64'

•

ivgen-hash-alg ( QCryptoHashAlgo , optional ) -- the initialization vector generator hash Currently defaults to 'sha256'

•

hash-alg ( QCryptoHashAlgo , 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 .

•

The members of QCryptoBlockOptionsBase .

•

When format is qcow : The members of QCryptoBlockOptionsQCow .

•

When format is luks : The members of QCryptoBlockOptionsLUKS .

•

The members of QCryptoBlockOptionsBase .

•

When format is qcow : The members of QCryptoBlockOptionsQCow .

•

When format is luks : The members of QCryptoBlockCreateOptionsLUKS .

•

format ( QCryptoBlockFormat ) -- the encryption format

•

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

•

cipher-alg ( QCryptoCipherAlgo ) -- the cipher algorithm for data encryption

•

cipher-mode ( QCryptoCipherMode ) -- the cipher mode for data encryption

•

ivgen-alg ( QCryptoIVGenAlgo ) -- the initialization vector generator

•

ivgen-hash-alg ( QCryptoHashAlgo , optional ) -- the initialization vector generator hash

•

hash-alg ( QCryptoHashAlgo ) -- the master key hash algorithm

•

detached-header ( boolean ) -- whether the LUKS header is detached (Since 9.0)

•

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 ( [ QCryptoBlockInfoLUKSSlot ] ) -- information about each key slot

•

The members of QCryptoBlockInfoBase .

•

When format is luks : The members of QCryptoBlockInfoLUKS .

Values

•

active -- The slots contain the given password and marked as active

•

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

•

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 ) --

•

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

•

The members of QCryptoBlockOptionsBase .

•

When format is luks : The members of QCryptoBlockAmendOptionsLUKS .

•

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.

•

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 .

•

serial ( int ) -- serial number that identifies a key to get from the kernel

•

The members of SecretCommonProperties .

•

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

•

The members of TlsCredsProperties .

•

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 .

•

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 .

Values

•

rsa -- RSA algorithm

Values

•

public -- public key

•

private -- private key

Values

•

raw -- no padding used

•

pkcs1 -- pkcs1#v1.5

•

hash-alg ( QCryptoHashAlgo ) -- QCryptoHashAlgo

•

padding-alg ( QCryptoRSAPaddingAlgo ) -- QCryptoRSAPaddingAlgo

•

alg ( QCryptoAkCipherAlgo ) -- encryption cipher algorithm

•

When alg is rsa : The members of QCryptoAkCipherOptionsRSA .

Values

•

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)

Values

•

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.

Values

•

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

•

change -- see block-job-change (since 8.2)

•

id ( string ) -- The job identifier

•

status ( JobStatus ) -- The new job status

•

id ( string ) -- The job identifier.

•

id ( string ) -- The job identifier.

•

id ( string ) -- The job identifier.

•

id ( string ) -- The job identifier.

•

id ( string ) -- The job identifier.

•

id ( string ) -- The identifier of any job in the transaction, or of a job that is not part of any transaction.

•

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 ) --

Return

[ JobInfo ] -- a list with a JobInfo for each active job

•

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)

•

format ( BlockdevQcow2EncryptionFormat ) -- The encryption format

•

The members of ImageInfoSpecificQCow2EncryptionBase .

•

When format is luks : The members of QCryptoBlockInfoLUKS .

•

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)

•

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

•

bitmaps ( [ Qcow2BitmapInfo ] , optional ) -- A list of qcow2 bitmap details (since 4.0)

•

compression-type ( Qcow2CompressionType ) -- the image cluster compression method (since 5.1)

•

create-type ( string ) -- The create type of VMDK image

•

cid ( int ) -- Content id of image

•

parent-cid ( int ) -- Parent VMDK image's cid

•

extents ( [ VmdkExtentInfo ] ) -- List of extent files

•

filename ( string ) -- Name of the extent file

•

format ( string ) -- Extent type (e.g. FLAT or SPARSE)

•

virtual-size ( int ) -- Number of bytes covered by this extent

•

cluster-size ( int , optional ) -- Cluster size in bytes (for non-flat extents)

•

compressed ( boolean , optional ) -- Whether this extent contains compressed data

•

encryption-format ( RbdImageEncryptionFormat , optional ) -- Image encryption format. If encryption is enabled for the image (see encrypted in BlockNodeInfo), this is the actual format in which the image is accessed. If encryption is not enabled, this is the result of probing when the image was opened, to give a suggestion which encryption format could be enabled. Note that probing results can be changed by the guest by writing a (possibly partial) encryption format header to the image, so don't treat this information as trusted if the guest is not trusted.

•

extent-size-hint ( int , optional ) -- Extent size hint (if available)

Values

•

luks -- Since 2.7

•

rbd -- Since 6.1

•

file -- Since 8.0

•

qcow2 -- Not documented

•

vmdk -- Not documented

•

data ( ImageInfoSpecificQCow2 ) -- image information specific to QCOW2

•

data ( ImageInfoSpecificVmdk ) -- image information specific to VMDK

•

data ( QCryptoBlockInfoLUKS ) -- image information specific to LUKS

•

data ( ImageInfoSpecificRbd ) -- image information specific to RBD

•

data ( ImageInfoSpecificFile ) -- image information specific to files

•

type ( ImageInfoSpecificKind ) -- block driver name

•

When type is qcow2 : The members of ImageInfoSpecificQCow2Wrapper .

•

When type is vmdk : The members of ImageInfoSpecificVmdkWrapper .

•

When type is luks : The members of ImageInfoSpecificLUKSWrapper .

•

When type is rbd : The members of ImageInfoSpecificRbdWrapper .

•

When type is file : The members of ImageInfoSpecificFileWrapper .

•

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 ( [ SnapshotInfo ] , optional ) -- list of VM snapshots

•

format-specific ( ImageInfoSpecific , optional ) -- structure supplying additional format-specific information (since 1.7)

•

backing-image ( ImageInfo , optional ) -- info of the backing image

•

The members of BlockNodeInfo .

•

name ( string ) -- Child name of the root node in the BlockGraphInfo struct, in its role as the child of some undescribed parent node

•

info ( BlockGraphInfo ) -- Block graph information starting at this node

•

children ( [ BlockChildInfo ] ) -- Array of links to this node's child nodes' information

•

The members of BlockNodeInfo .

•

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

•

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

•

compressed ( boolean ) -- true if the data is stored compressed (since 8.2)

•

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

•

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

•

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)

•

active ( boolean ) -- true if the backend is active; typical cases for inactive backends are on the migration source instance after migration completes and on the destination before it completes. (since: 10.0)

•

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 ( [ BlockDirtyInfo ] , optional ) -- dirty bitmaps information (only present if node has one or more dirty bitmaps) (Since 4.2)

Values

•

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

•

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. (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. (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)

Values

•

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.

•

name ( string ) -- the name of the bitmap

•

granularity ( int ) -- granularity of the bitmap in bytes

•

flags ( [ Qcow2BitmapInfoFlags ] ) -- flags of the bitmap

•

boundaries ( [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 ( [int] ) --

•

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)

•

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

•

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)

Return

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

•

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_zone_append_latency_ns ( int ) -- Minimum latency of zone append operations in the defined interval, in nanoseconds (since 8.1)

•

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_zone_append_latency_ns ( int ) -- Maximum latency of zone append operations in the defined interval, in nanoseconds (since 8.1)

•

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_zone_append_latency_ns ( int ) -- Average latency of zone append operations in the defined interval, in nanoseconds (since 8.1)

•

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.

•

avg_zone_append_queue_depth ( number ) -- Average number of pending zone append operations in the defined interval (since 8.1).

•

rd_bytes ( int ) -- The number of bytes read by the device.

•

wr_bytes ( int ) -- The number of bytes written by the device.

•

zone_append_bytes ( int ) -- The number of bytes appended by the zoned devices (since 8.1)

•

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.

•

zone_append_operations ( int ) -- The number of zone append operations performed by the zoned devices (since 8.1)

•

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).

•

zone_append_total_time_ns ( int ) -- Total time spent on zone append writes in nanoseconds (since 8.1)

•

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).

•

zone_append_merged ( int ) -- Number of zone append requests that have been merged into another request (since 8.1)

•

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_zone_append_operations ( int ) -- The number of failed zone append write operations performed by the zoned devices (since 8.1)

•

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_zone_append_operations ( int ) -- The number of invalid zone append operations performed by the zoned device (since 8.1)

•

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 ( [ BlockDeviceTimedStats ] ) -- Statistics specific to the set of previously defined intervals of time (Since 2.5)

•

rd_latency_histogram ( BlockLatencyHistogramInfo , optional ) -- BlockLatencyHistogramInfo . (Since 4.0)

•

wr_latency_histogram ( BlockLatencyHistogramInfo , optional ) -- BlockLatencyHistogramInfo . (Since 4.0)

•

zone_append_latency_histogram (- BlockLatencyHistogramInfo , optional ) -- BlockLatencyHistogramInfo . (since 8.1)

•

flush_latency_histogram ( BlockLatencyHistogramInfo , optional ) -- BlockLatencyHistogramInfo . (Since 4.0)

•

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.

•

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.

•

driver ( BlockdevDriver ) -- block driver name

•

When driver is file : The members of BlockStatsSpecificFile .

•

When driver is host_device : The members of BlockStatsSpecificFile .

•

When driver is nvme : The members of BlockStatsSpecificNvme .

•

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)

•

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)

Return

Values

•

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)

Values

•

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.

Values

•

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.

Values

•

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.

•

actively-synced ( boolean ) -- Whether the source is actively synced to the target, i.e. same data and new writes are done synchronously to both.

•

type ( JobType ) -- 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)

•

When type is mirror : The members of BlockJobInfoMirror .

Return

[ BlockJobInfo ] -- a list of BlockJobInfo for each active block job

•

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

Errors

•

If device is not a valid block device, DeviceNotFound

Values

•

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.

•

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).

•

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.

•

min-cluster-size ( int , optional ) -- Minimum size of blocks used by copy-before-write and background copy operations. Has to be a power of 2. No effect if smaller than the maximum of the target's cluster size and 64 KiB. Default 0. (Since 9.2)

•

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)

•

discard-source ( boolean , optional ) -- Discard blocks on source which have already been copied to the target. (Since 9.1)

•

x-perf ( BackupPerf , optional ) -- Performance options. (Since 6.0)

•

unstable -- Member x-perf is experimental.

•

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 .

•

target ( string ) -- the device name or node-name of the backup target node.

•

The members of BackupCommon .

•

The members of BlockdevSnapshotSync .

Errors

•

If device is not a valid block device, DeviceNotFound

•

The members of BlockdevSnapshot .