System Emulation Management and Interoperability

This section of the manual contains documents and specifications that are useful for making QEMU interoperate with other software.

• Barrier client protocol
  • Message format
  • Protocol Description
• Dirty Bitmaps and Incremental Backup
  • Overview
  • Supported Image Formats
  • Dirty Bitmap Names
  • Bitmap Status
  • Basic QMP Usage
  • Bitmap Persistence
  • Transactions
  • Incremental Backups - Push Model
  • Push Backup Errors & Recovery
• D-Bus
  • Introduction
  • Security
  • Guidelines
  • QEMU Interfaces
• D-Bus VMState
  • org.qemu.VMState1 interface
• D-Bus display
  • org.qemu.Display1.VM interface
  • org.qemu.Display1.Console interface
  • org.qemu.Display1.Keyboard interface
  • org.qemu.Display1.Mouse interface
  • org.qemu.Display1.MultiTouch interface
  • org.qemu.Display1.Listener interface
  • org.qemu.Display1.Listener.Unix.Map interface
  • org.qemu.Display1.Listener.Win32.Map interface
  • org.qemu.Display1.Listener.Win32.D3d11 interface
  • org.qemu.Display1.Listener.Unix.ScanoutDMABUF2 interface
  • org.qemu.Display1.Clipboard interface
  • org.qemu.Display1.Audio interface
  • org.qemu.Display1.AudioOutListener interface
  • org.qemu.Display1.AudioInListener interface
  • org.qemu.Display1.Chardev interface
• Live Block Device Operations
  • Disk image backing chain notation
  • Brief overview of live block QMP primitives
  • Interacting with a QEMU instance
  • Example disk image chain
  • A note on points-in-time vs file names
  • Live block streaming — block-stream
  • Live block commit — block-commit
  • Live disk synchronization — drive-mirror and blockdev-mirror
  • Live disk backup — blockdev-backup and the deprecated drive-backup
• QEMU NBD protocol support
  • Metadata namespaces
  • qemu namespace
  • Features by version
• Parallels Expandable Image File Format
  • Definitions
  • Header
  • BAT
  • Data Area
  • Format Extension
  • Dirty bitmaps feature
• Parallels Disk Format
  • Definitions
  • Description file
• Qcow2 Image File Format
  • Header
  • Additional fields (version 3 and higher)
  • Header padding
  • Header extensions
  • String header extensions
  • Feature name table
  • Bitmaps extension
  • Full disk encryption header pointer
  • Data encryption
  • Host cluster management
  • Cluster mapping
  • Extended L2 Entries
  • Snapshots
  • Bitmaps
  • Bitmap directory
  • Bitmap table
  • Bitmap data
  • Dirty tracking bitmaps
• QED Image File Format Specification
  • Header
  • Tables
  • Consistency checking
• Persistent reservation helper protocol
  • Connection and initialization
  • Command format
• QEMU Machine Protocol Specification
  • Protocol Specification
  • QMP Examples
  • Capabilities Negotiation
  • Compatibility Considerations
  • Downstream extension of QMP
• QEMU Guest Agent
  • Synopsis
  • Description
  • Options
  • Files
  • See also
• QEMU Guest Agent Protocol Reference
  • guest-sync-delimited
  • guest-sync
  • guest-ping
  • guest-get-time
  • guest-set-time
  • GuestAgentCommandInfo
  • GuestAgentInfo
  • guest-info
  • guest-shutdown
  • guest-file-open
  • guest-file-close
  • GuestFileRead
  • guest-file-read
  • GuestFileWrite
  • guest-file-write
  • GuestFileSeek
  • QGASeek
  • GuestFileWhence
  • guest-file-seek
  • guest-file-flush
  • GuestFsfreezeStatus
  • guest-fsfreeze-status
  • guest-fsfreeze-freeze
  • guest-fsfreeze-freeze-list
  • guest-fsfreeze-thaw
  • GuestFilesystemTrimResult
  • GuestFilesystemTrimResponse
  • guest-fstrim
  • guest-suspend-disk
  • guest-suspend-ram
  • guest-suspend-hybrid
  • GuestIpAddressType
  • GuestIpAddress
  • GuestNetworkInterfaceStat
  • GuestNetworkInterface
  • guest-network-get-interfaces
  • GuestLogicalProcessor
  • guest-get-vcpus
  • guest-set-vcpus
  • GuestDiskBusType
  • GuestPCIAddress
  • GuestCCWAddress
  • GuestDiskAddress
  • GuestNVMeSmart
  • GuestDiskSmart
  • GuestDiskInfo
  • guest-get-disks
  • GuestFilesystemInfo
  • guest-get-fsinfo
  • guest-set-user-password
  • GuestMemoryBlock
  • guest-get-memory-blocks
  • GuestMemoryBlockResponseType
  • GuestMemoryBlockResponse
  • guest-set-memory-blocks
  • GuestMemoryBlockInfo
  • guest-get-memory-block-info
  • GuestExecStatus
  • guest-exec-status
  • GuestExec
  • GuestExecCaptureOutputMode
  • GuestExecCaptureOutput
  • guest-exec
  • GuestHostName
  • guest-get-host-name
  • GuestUser
  • guest-get-users
  • GuestTimezone
  • guest-get-timezone
  • GuestOSInfo
  • guest-get-osinfo
  • GuestDeviceType
  • GuestDeviceIdPCI
  • GuestDeviceId
  • GuestDeviceInfo
  • guest-get-devices
  • GuestAuthorizedKeys
  • guest-ssh-get-authorized-keys
  • guest-ssh-add-authorized-keys
  • guest-ssh-remove-authorized-keys
  • GuestDiskStats
  • GuestDiskStatsInfo
  • guest-get-diskstats
  • GuestCpuStatsType
  • GuestLinuxCpuStats
  • GuestCpuStats
  • guest-get-cpustats
  • GuestLoadAverage
  • guest-get-load
  • GuestNetworkRoute
  • guest-network-get-route
• QEMU QMP Reference Manual
  • Introduction
  • QMP errors
  • Common data types
  • Socket data types
  • VM run state
  • Cryptography
  • Background jobs
  • Accelerators
  • Block devices
  • Character devices
  • Dump guest memory
  • Net devices
  • eBPF Objects
  • Rocker switch device
  • TPM (trusted platform module) devices
  • Remote desktop
  • Input
  • 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
• QEMU Storage Daemon QMP Reference Manual
  • Introduction
  • Common data types
  • Socket data types
  • Cryptography
  • Background jobs
  • Block devices
  • Character devices
  • User authorization
  • Transactions
  • QMP monitor control
  • QMP introspection
  • QEMU Object Model (QOM)
• vfio-user Protocol Specification
  • Introduction
  • Overview
  • Client/server interactions
  • Protocol Specification
  • Appendices
• Vhost-user Protocol
  • Introduction
  • Message Specification
  • Communication
  • Backend program conventions
• Vhost-user-gpu Protocol
  • Introduction
  • Wire format
  • Communication
• Vhost-vdpa Protocol
  • Introduction
• Virtio balloon memory statistics
• VNC LED state Pseudo-encoding
  • Introduction
  • Pseudo-encoding
  • LED state Pseudo-encoding