qemu-qmp-ref - Man Page

• QEMU QMP Reference Manual

  • Introduction

  • QMP errors

    • QapiErrorClass (Enum)

  • Common data types

    • IoOperationType (Enum)
    • OnOffAuto (Enum)
    • OnOffSplit (Enum)
    • StrOrNull (Alternate)
    • OffAutoPCIBAR (Enum)
    • PCIELinkSpeed (Enum)
    • PCIELinkWidth (Enum)
    • HostMemPolicy (Enum)
    • NetFilterDirection (Enum)
    • GrabToggleKeys (Enum)
    • HumanReadableText (Object)

  • Socket data types

    • NetworkAddressFamily (Enum)
    • InetSocketAddressBase (Object)
    • InetSocketAddress (Object)
    • UnixSocketAddress (Object)
    • VsockSocketAddress (Object)
    • FdSocketAddress (Object)
    • InetSocketAddressWrapper (Object)
    • UnixSocketAddressWrapper (Object)
    • VsockSocketAddressWrapper (Object)
    • FdSocketAddressWrapper (Object)
    • SocketAddressLegacy (Object)
    • SocketAddressType (Enum)
    • SocketAddress (Object)

  • VM run state

    • RunState (Enum)
    • ShutdownCause (Enum)
    • StatusInfo (Object)
    • query-status (Command)
    • SHUTDOWN (Event)
    • POWERDOWN (Event)
    • RESET (Event)
    • STOP (Event)
    • RESUME (Event)
    • SUSPEND (Event)
    • SUSPEND_DISK (Event)
    • WAKEUP (Event)
    • WATCHDOG (Event)
    • WatchdogAction (Enum)
    • RebootAction (Enum)
    • ShutdownAction (Enum)
    • PanicAction (Enum)
    • watchdog-set-action (Command)
    • set-action (Command)
    • GUEST_PANICKED (Event)
    • GUEST_CRASHLOADED (Event)
    • GUEST_PVSHUTDOWN (Event)
    • GuestPanicAction (Enum)
    • GuestPanicInformationType (Enum)
    • GuestPanicInformation (Object)
    • GuestPanicInformationHyperV (Object)
    • S390CrashReason (Enum)
    • GuestPanicInformationS390 (Object)
    • MEMORY_FAILURE (Event)
    • MemoryFailureRecipient (Enum)
    • MemoryFailureAction (Enum)
    • MemoryFailureFlags (Object)
    • NotifyVmexitOption (Enum)

  • Cryptography

    • QCryptoTLSCredsEndpoint (Enum)
    • QCryptoSecretFormat (Enum)
    • QCryptoHashAlgo (Enum)
    • QCryptoCipherAlgo (Enum)
    • QCryptoCipherMode (Enum)
    • QCryptoIVGenAlgo (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)
    • QCryptoAkCipherAlgo (Enum)
    • QCryptoAkCipherKeyType (Enum)
    • QCryptoRSAPaddingAlgo (Enum)
    • QCryptoAkCipherOptionsRSA (Object)
    • QCryptoAkCipherOptions (Object)

  • Background jobs

    • JobType (Enum)
    • JobStatus (Enum)
    • JobVerb (Enum)
    • JOB_STATUS_CHANGE (Event)
    • job-pause (Command)
    • job-resume (Command)
    • job-cancel (Command)
    • job-complete (Command)
    • job-dismiss (Command)
    • job-finalize (Command)
    • JobInfo (Object)
    • query-jobs (Command)

  • Block devices

    • Block core (VM unrelated)
    • Additional block stuff (VM related)
    • 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)
    • ChardevDBus (Object)
    • ChardevVC (Object)
    • ChardevRingbuf (Object)
    • ChardevQemuVDAgent (Object)
    • ChardevPty (Object)
    • ChardevBackendKind (Enum)
    • ChardevFileWrapper (Object)
    • ChardevHostdevWrapper (Object)
    • ChardevSocketWrapper (Object)
    • ChardevUdpWrapper (Object)
    • ChardevCommonWrapper (Object)
    • ChardevMuxWrapper (Object)
    • ChardevStdioWrapper (Object)
    • ChardevSpiceChannelWrapper (Object)
    • ChardevSpicePortWrapper (Object)
    • ChardevQemuVDAgentWrapper (Object)
    • ChardevDBusWrapper (Object)
    • ChardevVCWrapper (Object)
    • ChardevRingbufWrapper (Object)
    • ChardevPtyWrapper (Object)
    • ChardevBackend (Object)
    • ChardevReturn (Object)
    • chardev-add (Command)
    • chardev-change (Command)
    • chardev-remove (Command)
    • chardev-send-break (Command)
    • VSERPORT_CHANGE (Event)

  • Dump guest memory

    • DumpGuestMemoryFormat (Enum)
    • dump-guest-memory (Command)
    • DumpStatus (Enum)
    • DumpQueryResult (Object)
    • query-dump (Command)
    • DUMP_COMPLETED (Event)
    • DumpGuestMemoryCapability (Object)
    • query-dump-guest-memory-capability (Command)

  • Net devices

    • set_link (Command)
    • netdev_add (Command)
    • netdev_del (Command)
    • NetLegacyNicOptions (Object)
    • String (Object)
    • NetdevUserOptions (Object)
    • NetdevTapOptions (Object)
    • NetdevSocketOptions (Object)
    • NetdevL2TPv3Options (Object)
    • NetdevVdeOptions (Object)
    • NetdevBridgeOptions (Object)
    • NetdevHubPortOptions (Object)
    • NetdevNetmapOptions (Object)
    • AFXDPMode (Enum)
    • NetdevAFXDPOptions (Object)
    • NetdevVhostUserOptions (Object)
    • NetdevVhostVDPAOptions (Object)
    • NetdevVmnetHostOptions (Object)
    • NetdevVmnetSharedOptions (Object)
    • NetdevVmnetBridgedOptions (Object)
    • NetdevStreamOptions (Object)
    • NetdevDgramOptions (Object)
    • NetClientDriver (Enum)
    • Netdev (Object)
    • RxState (Enum)
    • RxFilterInfo (Object)
    • query-rx-filter (Command)
    • NIC_RX_FILTER_CHANGED (Event)
    • AnnounceParameters (Object)
    • announce-self (Command)
    • FAILOVER_NEGOTIATED (Event)
    • NETDEV_STREAM_CONNECTED (Event)
    • NETDEV_STREAM_DISCONNECTED (Event)

  • eBPF Objects

    • EbpfObject (Object)
    • EbpfProgramID (Enum)
    • request-ebpf (Command)

  • Rocker switch device

    • RockerSwitch (Object)
    • query-rocker (Command)
    • RockerPortDuplex (Enum)
    • RockerPortAutoneg (Enum)
    • RockerPort (Object)
    • query-rocker-ports (Command)
    • RockerOfDpaFlowKey (Object)
    • RockerOfDpaFlowMask (Object)
    • RockerOfDpaFlowAction (Object)
    • RockerOfDpaFlow (Object)
    • query-rocker-of-dpa-flows (Command)
    • RockerOfDpaGroup (Object)
    • query-rocker-of-dpa-groups (Command)

  • TPM (trusted platform module) devices

    • TpmModel (Enum)
    • query-tpm-models (Command)
    • TpmType (Enum)
    • query-tpm-types (Command)
    • TPMPassthroughOptions (Object)
    • TPMEmulatorOptions (Object)
    • TPMPassthroughOptionsWrapper (Object)
    • TPMEmulatorOptionsWrapper (Object)
    • TpmTypeOptions (Object)
    • TPMInfo (Object)
    • query-tpm (Command)

  • Remote desktop

    • DisplayProtocol (Enum)
    • SetPasswordAction (Enum)
    • SetPasswordOptions (Object)
    • SetPasswordOptionsVnc (Object)
    • set_password (Command)
    • ExpirePasswordOptions (Object)
    • ExpirePasswordOptionsVnc (Object)
    • expire_password (Command)
    • ImageFormat (Enum)
    • screendump (Command)
    • Spice
    • VNC

  • Input

    • MouseInfo (Object)
    • query-mice (Command)
    • QKeyCode (Enum)
    • KeyValueKind (Enum)
    • IntWrapper (Object)
    • QKeyCodeWrapper (Object)
    • KeyValue (Object)
    • send-key (Command)
    • InputButton (Enum)
    • InputAxis (Enum)
    • InputMultiTouchType (Enum)
    • InputKeyEvent (Object)
    • InputBtnEvent (Object)
    • InputMoveEvent (Object)
    • InputMultiTouchEvent (Object)
    • InputEventKind (Enum)
    • InputKeyEventWrapper (Object)
    • InputBtnEventWrapper (Object)
    • InputMoveEventWrapper (Object)
    • InputMultiTouchEventWrapper (Object)
    • InputEvent (Object)
    • input-send-event (Command)
    • DisplayGTK (Object)
    • DisplayEGLHeadless (Object)
    • DisplayDBus (Object)
    • DisplayGLMode (Enum)
    • DisplayCurses (Object)
    • DisplayCocoa (Object)
    • HotKeyMod (Enum)
    • DisplaySDL (Object)
    • DisplayType (Enum)
    • DisplayOptions (Object)
    • query-display-options (Command)
    • DisplayReloadType (Enum)
    • DisplayReloadOptionsVNC (Object)
    • DisplayReloadOptions (Object)
    • display-reload (Command)
    • DisplayUpdateType (Enum)
    • DisplayUpdateOptionsVNC (Object)
    • DisplayUpdateOptions (Object)
    • display-update (Command)
    • client_migrate_info (Command)

  • User authorization

    • QAuthZListPolicy (Enum)
    • QAuthZListFormat (Enum)
    • QAuthZListRule (Object)
    • AuthZListProperties (Object)
    • AuthZListFileProperties (Object)
    • AuthZPAMProperties (Object)
    • AuthZSimpleProperties (Object)

  • Migration

    • MigrationStats (Object)
    • XBZRLECacheStats (Object)
    • CompressionStats (Object)
    • MigrationStatus (Enum)
    • VfioStats (Object)
    • MigrationInfo (Object)
    • query-migrate (Command)
    • MigrationCapability (Enum)
    • MigrationCapabilityStatus (Object)
    • migrate-set-capabilities (Command)
    • query-migrate-capabilities (Command)
    • MultiFDCompression (Enum)
    • MigMode (Enum)
    • ZeroPageDetection (Enum)
    • BitmapMigrationBitmapAliasTransform (Object)
    • BitmapMigrationBitmapAlias (Object)
    • BitmapMigrationNodeAlias (Object)
    • MigrationParameter (Enum)
    • MigrateSetParameters (Object)
    • migrate-set-parameters (Command)
    • MigrationParameters (Object)
    • query-migrate-parameters (Command)
    • migrate-start-postcopy (Command)
    • MIGRATION (Event)
    • MIGRATION_PASS (Event)
    • COLOMessage (Enum)
    • COLOMode (Enum)
    • FailoverStatus (Enum)
    • COLO_EXIT (Event)
    • COLOExitReason (Enum)
    • x-colo-lost-heartbeat (Command)
    • migrate_cancel (Command)
    • migrate-continue (Command)
    • MigrationAddressType (Enum)
    • FileMigrationArgs (Object)
    • MigrationExecCommand (Object)
    • MigrationAddress (Object)
    • MigrationChannelType (Enum)
    • MigrationChannel (Object)
    • migrate (Command)
    • migrate-incoming (Command)
    • xen-save-devices-state (Command)
    • xen-set-global-dirty-log (Command)
    • xen-load-devices-state (Command)
    • xen-set-replication (Command)
    • ReplicationStatus (Object)
    • query-xen-replication-status (Command)
    • xen-colo-do-checkpoint (Command)
    • COLOStatus (Object)
    • query-colo-status (Command)
    • migrate-recover (Command)
    • migrate-pause (Command)
    • UNPLUG_PRIMARY (Event)
    • DirtyRateVcpu (Object)
    • DirtyRateStatus (Enum)
    • DirtyRateMeasureMode (Enum)
    • TimeUnit (Enum)
    • DirtyRateInfo (Object)
    • calc-dirty-rate (Command)
    • query-dirty-rate (Command)
    • DirtyLimitInfo (Object)
    • set-vcpu-dirty-limit (Command)
    • cancel-vcpu-dirty-limit (Command)
    • query-vcpu-dirty-limit (Command)
    • MigrationThreadInfo (Object)
    • query-migrationthreads (Command)
    • snapshot-save (Command)
    • snapshot-load (Command)
    • snapshot-delete (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)

  • Tracing

    • TraceEventState (Enum)
    • TraceEventInfo (Object)
    • trace-event-get-state (Command)
    • trace-event-set-state (Command)

  • Compatibility policy

    • CompatPolicyInput (Enum)
    • CompatPolicyOutput (Enum)
    • CompatPolicy (Object)

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

  • 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)
    • EventLoopBaseProperties (Object)
    • IothreadProperties (Object)
    • MainLoopProperties (Object)
    • MemoryBackendProperties (Object)
    • MemoryBackendFileProperties (Object)
    • MemoryBackendMemfdProperties (Object)
    • MemoryBackendShmProperties (Object)
    • MemoryBackendEpcProperties (Object)
    • PrManagerHelperProperties (Object)
    • QtestProperties (Object)
    • RemoteObjectProperties (Object)
    • VfioUserServerProperties (Object)
    • IOMMUFDProperties (Object)
    • AcpiGenericInitiatorProperties (Object)
    • AcpiGenericPortProperties (Object)
    • RngProperties (Object)
    • RngEgdProperties (Object)
    • RngRandomProperties (Object)
    • SevCommonProperties (Object)
    • SevGuestProperties (Object)
    • SevSnpGuestProperties (Object)
    • ThreadContextProperties (Object)
    • ObjectType (Enum)
    • ObjectOptions (Object)
    • object-add (Command)
    • object-del (Command)

  • Device infrastructure (qdev)

    • device-list-properties (Command)
    • device_add (Command)
    • device_del (Command)
    • DEVICE_DELETED (Event)
    • DEVICE_UNPLUG_GUEST_ERROR (Event)
    • device-sync-config (Command)

  • Common machine types

    • S390CpuEntitlement (Enum)
    • CpuTopologyLevel (Enum)
    • CacheLevelAndType (Enum)
    • SmpCacheProperties (Object)
    • SmpCachePropertiesWrapper (Object)

  • Machines

    • SysEmuTarget (Enum)
    • S390CpuState (Enum)
    • CpuInfoS390 (Object)
    • CpuInfoFast (Object)
    • query-cpus-fast (Command)
    • CompatProperty (Object)
    • MachineInfo (Object)
    • query-machines (Command)
    • CurrentMachineParams (Object)
    • query-current-machine (Command)
    • TargetInfo (Object)
    • query-target (Command)
    • UuidInfo (Object)
    • query-uuid (Command)
    • GuidInfo (Object)
    • query-vm-generation-id (Command)
    • system_reset (Command)
    • system_powerdown (Command)
    • system_wakeup (Command)
    • LostTickPolicy (Enum)
    • inject-nmi (Command)
    • KvmInfo (Object)
    • query-kvm (Command)
    • NumaOptionsType (Enum)
    • NumaOptions (Object)
    • NumaNodeOptions (Object)
    • NumaDistOptions (Object)
    • CXLFixedMemoryWindowOptions (Object)
    • CXLFMWProperties (Object)
    • X86CPURegister32 (Enum)
    • X86CPUFeatureWordInfo (Object)
    • DummyForceArrays (Object)
    • NumaCpuOptions (Object)
    • HmatLBMemoryHierarchy (Enum)
    • HmatLBDataType (Enum)
    • NumaHmatLBOptions (Object)
    • HmatCacheAssociativity (Enum)
    • HmatCacheWritePolicy (Enum)
    • NumaHmatCacheOptions (Object)
    • memsave (Command)
    • pmemsave (Command)
    • Memdev (Object)
    • query-memdev (Command)
    • CpuInstanceProperties (Object)
    • HotpluggableCPU (Object)
    • query-hotpluggable-cpus (Command)
    • set-numa-node (Command)
    • balloon (Command)
    • BalloonInfo (Object)
    • query-balloon (Command)
    • BALLOON_CHANGE (Event)
    • HvBalloonInfo (Object)
    • query-hv-balloon-status-report (Command)
    • HV_BALLOON_STATUS_REPORT (Event)
    • MemoryInfo (Object)
    • query-memory-size-summary (Command)
    • PCDIMMDeviceInfo (Object)
    • VirtioPMEMDeviceInfo (Object)
    • VirtioMEMDeviceInfo (Object)
    • SgxEPCDeviceInfo (Object)
    • HvBalloonDeviceInfo (Object)
    • MemoryDeviceInfoKind (Enum)
    • PCDIMMDeviceInfoWrapper (Object)
    • VirtioPMEMDeviceInfoWrapper (Object)
    • VirtioMEMDeviceInfoWrapper (Object)
    • SgxEPCDeviceInfoWrapper (Object)
    • HvBalloonDeviceInfoWrapper (Object)
    • MemoryDeviceInfo (Object)
    • SgxEPC (Object)
    • SgxEPCProperties (Object)
    • query-memory-devices (Command)
    • MEMORY_DEVICE_SIZE_CHANGE (Event)
    • BootConfiguration (Object)
    • SMPConfiguration (Object)
    • x-query-irq (Command)
    • x-query-jit (Command)
    • x-query-numa (Command)
    • x-query-opcount (Command)
    • x-query-ramblock (Command)
    • x-query-roms (Command)
    • x-query-usb (Command)
    • SmbiosEntryPointType (Enum)
    • MemorySizeConfiguration (Object)
    • dumpdtb (Command)
    • x-query-interrupt-controllers (Command)
    • CpuModelInfo (Object)
    • CpuModelExpansionType (Enum)
    • CpuModelCompareResult (Enum)
    • CpuModelBaselineInfo (Object)
    • CpuModelCompareInfo (Object)
    • query-cpu-model-comparison (Command)
    • query-cpu-model-baseline (Command)
    • CpuModelExpansionInfo (Object)
    • query-cpu-model-expansion (Command)
    • CpuDefinitionInfo (Object)
    • query-cpu-definitions (Command)
    • S390CpuPolarization (Enum)
    • set-cpu-topology (Command)
    • CPU_POLARIZATION_CHANGE (Event)
    • CpuPolarizationInfo (Object)
    • query-s390x-cpu-polarization (Command)

  • Record/replay

    • ReplayMode (Enum)
    • ReplayInfo (Object)
    • query-replay (Command)
    • replay-break (Command)
    • replay-delete-break (Command)
    • replay-seek (Command)

  • Yank feature

    • YankInstanceType (Enum)
    • YankInstanceBlockNode (Object)
    • YankInstanceChardev (Object)
    • YankInstance (Object)
    • yank (Command)
    • query-yank (Command)

  • Miscellanea

    • add_client (Command)
    • NameInfo (Object)
    • query-name (Command)
    • IOThreadInfo (Object)
    • query-iothreads (Command)
    • stop (Command)
    • cont (Command)
    • x-exit-preconfig (Command)
    • human-monitor-command (Command)
    • getfd (Command)
    • get-win32-socket (Command)
    • closefd (Command)
    • AddfdInfo (Object)
    • add-fd (Command)
    • remove-fd (Command)
    • FdsetFdInfo (Object)
    • FdsetInfo (Object)
    • query-fdsets (Command)
    • CommandLineParameterType (Enum)
    • CommandLineParameterInfo (Object)
    • CommandLineOptionInfo (Object)
    • query-command-line-options (Command)
    • RTC_CHANGE (Event)
    • VFU_CLIENT_HANGUP (Event)
    • rtc-reset-reinjection (Command)
    • SevState (Enum)
    • SevGuestType (Enum)
    • SevGuestInfo (Object)
    • SevSnpGuestInfo (Object)
    • SevInfo (Object)
    • query-sev (Command)
    • SevLaunchMeasureInfo (Object)
    • query-sev-launch-measure (Command)
    • SevCapability (Object)
    • query-sev-capabilities (Command)
    • sev-inject-launch-secret (Command)
    • SevAttestationReport (Object)
    • query-sev-attestation-report (Command)
    • dump-skeys (Command)
    • GICCapability (Object)
    • query-gic-capabilities (Command)
    • SGXEPCSection (Object)
    • SGXInfo (Object)
    • query-sgx (Command)
    • query-sgx-capabilities (Command)
    • EvtchnPortType (Enum)
    • EvtchnInfo (Object)
    • xen-event-list (Command)
    • xen-event-inject (Command)

  • Audio

    • AudiodevPerDirectionOptions (Object)
    • AudiodevGenericOptions (Object)
    • AudiodevAlsaPerDirectionOptions (Object)
    • AudiodevAlsaOptions (Object)
    • AudiodevSndioOptions (Object)
    • AudiodevCoreaudioPerDirectionOptions (Object)
    • AudiodevCoreaudioOptions (Object)
    • AudiodevDsoundOptions (Object)
    • AudiodevJackPerDirectionOptions (Object)
    • AudiodevJackOptions (Object)
    • AudiodevOssPerDirectionOptions (Object)
    • AudiodevOssOptions (Object)
    • AudiodevPaPerDirectionOptions (Object)
    • AudiodevPaOptions (Object)
    • AudiodevPipewirePerDirectionOptions (Object)
    • AudiodevPipewireOptions (Object)
    • AudiodevSdlPerDirectionOptions (Object)
    • AudiodevSdlOptions (Object)
    • AudiodevWavOptions (Object)
    • AudioFormat (Enum)
    • AudiodevDriver (Enum)
    • Audiodev (Object)
    • query-audiodevs (Command)

  • ACPI

    • AcpiTableOptions (Object)
    • ACPISlotType (Enum)
    • ACPIOSTInfo (Object)
    • query-acpi-ospm-status (Command)
    • ACPI_DEVICE_OST (Event)

  • PCI

    • PciMemoryRange (Object)
    • PciMemoryRegion (Object)
    • PciBusInfo (Object)
    • PciBridgeInfo (Object)
    • PciDeviceClass (Object)
    • PciDeviceId (Object)
    • PciDeviceInfo (Object)
    • PciInfo (Object)
    • query-pci (Command)

  • Statistics

    • StatsType (Enum)
    • StatsUnit (Enum)
    • StatsProvider (Enum)
    • StatsTarget (Enum)
    • StatsRequest (Object)
    • StatsVCPUFilter (Object)
    • StatsFilter (Object)
    • StatsValue (Alternate)
    • Stats (Object)
    • StatsResult (Object)
    • query-stats (Command)
    • StatsSchemaValue (Object)
    • StatsSchema (Object)
    • query-stats-schemas (Command)

  • Virtio devices

    • VirtioInfo (Object)
    • x-query-virtio (Command)
    • VhostStatus (Object)
    • VirtioStatus (Object)
    • x-query-virtio-status (Command)
    • VirtioDeviceStatus (Object)
    • VhostDeviceProtocols (Object)
    • VirtioDeviceFeatures (Object)
    • VirtQueueStatus (Object)
    • x-query-virtio-queue-status (Command)
    • VirtVhostQueueStatus (Object)
    • x-query-virtio-vhost-queue-status (Command)
    • VirtioRingDesc (Object)
    • VirtioRingAvail (Object)
    • VirtioRingUsed (Object)
    • VirtioQueueElement (Object)
    • x-query-virtio-queue-element (Command)
    • IOThreadVirtQueueMapping (Object)
    • DummyVirtioForceArrays (Object)
    • GranuleMode (Enum)

  • VFIO devices

    • QapiVfioMigrationState (Enum)
    • VFIO_MIGRATION (Event)

  • Cryptography devices

    • QCryptodevBackendAlgoType (Enum)
    • QCryptodevBackendServiceType (Enum)
    • QCryptodevBackendType (Enum)
    • QCryptodevBackendClient (Object)
    • QCryptodevInfo (Object)
    • query-cryptodev (Command)

  • CXL devices

    • CxlEventLog (Enum)
    • cxl-inject-general-media-event (Command)
    • cxl-inject-dram-event (Command)
    • cxl-inject-memory-module-event (Command)
    • cxl-inject-poison (Command)
    • CxlUncorErrorType (Enum)
    • CXLUncorErrorRecord (Object)
    • cxl-inject-uncorrectable-errors (Command)
    • CxlCorErrorType (Enum)
    • cxl-inject-correctable-error (Command)
    • CxlDynamicCapacityExtent (Object)
    • CxlExtentSelectionPolicy (Enum)
    • cxl-add-dynamic-capacity (Command)
    • CxlExtentRemovalPolicy (Enum)
    • cxl-release-dynamic-capacity (Command)

QEMU error classes

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

1.2

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

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

32

32.0GT/s (since 9.0)

64

64.0GT/s (since 9.0)

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

Key combinations to toggle input-linux between host and guest.

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

4.0

human-readable-text: string

Formatted output intended for humans.

6.2

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

NOTE:

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

2.8

A file descriptor name or number.

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.

1.2

data: InetSocketAddress

internet domain socket address

1.3

data: UnixSocketAddress

UNIX domain socket address

1.3

data: VsockSocketAddress

VSOCK domain socket address

2.8

data: FdSocketAddress

file descriptor name or number

1.3

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

type: SocketAddressType

Transport type

The members of InetSocketAddressWrapper when type is "inet"

The members of UnixSocketAddressWrapper when type is "unix"

The members of VsockSocketAddressWrapper when type is "vsock"

The members of FdSocketAddressWrapper when type is "fd"

1.3

Available SocketAddress types

inet

Internet address

unix

Unix domain socket

vsock

VMCI address

fd

Socket file descriptor

2.9

Captures the address of a socket, which could also be a socket 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 FdSocketAddress when type is "fd"

2.9

An enumeration of VM run states.

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)

An enumeration of reasons for a Shutdown.

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)

Information about VM run state

running: boolean

true if all VCPUs are runnable, false if not runnable

status: RunState

the virtual machine RunState

0.14

Query the run status of the VM

StatusInfo reflecting the VM

0.14

Example:

-> { "execute": "query-status" }
<- { "return": { "running": true,
                 "status": "running" } }

Emitted when the virtual machine has shut down, indicating that qemu is about to exit.

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)

NOTE:

If the command-line option -no-shutdown has been specified, qemu will not exit, and a STOP event will eventually follow the SHUTDOWN event.

0.12

Example:

<- { "event": "SHUTDOWN",
     "data": { "guest": true, "reason": "guest-shutdown" },
     "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }

Emitted when the virtual machine is powered down through the power control system, such as via ACPI.

0.12

Example:

<- { "event": "POWERDOWN",
     "timestamp": { "seconds": 1267040730, "microseconds": 682951 } }

Emitted when the virtual machine is reset

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)

0.12

Example:

<- { "event": "RESET",
     "data": { "guest": false, "reason": "guest-reset" },
     "timestamp": { "seconds": 1267041653, "microseconds": 9518 } }

Emitted when the virtual machine is stopped

0.12

Example:

<- { "event": "STOP",
     "timestamp": { "seconds": 1267041730, "microseconds": 281295 } }

Emitted when the virtual machine resumes execution

0.12

Example:

<- { "event": "RESUME",
     "timestamp": { "seconds": 1271770767, "microseconds": 582542 } }

Emitted when guest enters a hardware suspension state, for example, S3 state, which is sometimes called standby state

1.1

Example:

<- { "event": "SUSPEND",
     "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }

Emitted when guest enters a hardware suspension state with data saved on disk, for example, S4 state, which is sometimes called hibernate state

NOTE:

1.2

Example:

<- { "event": "SUSPEND_DISK",
     "timestamp": { "seconds": 1344456160, "microseconds": 309119 } }

Emitted when the guest has woken up from suspend state and is running

1.1

Example:

<- { "event": "WAKEUP",
     "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }

Emitted when the watchdog device's timer is expired

action: WatchdogAction

action that has been taken

NOTE:

If action is "reset", "shutdown", or "pause" the WATCHDOG event is followed respectively by the RESET, SHUTDOWN, or STOP events.

NOTE:

This event is rate-limited.

0.13

Example:

<- { "event": "WATCHDOG",
     "data": { "action": "reset" },
     "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }

An enumeration of the actions taken when the watchdog device's timer is expired

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)

2.1

Possible QEMU actions upon guest reboot

reset

Reset the VM

shutdown

Shutdown the VM and exit, according to the shutdown action

6.0

Possible QEMU actions upon guest shutdown

poweroff

Shutdown the VM and exit

pause

pause the VM

6.0

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)

6.0

Set watchdog action.

action: WatchdogAction

WatchdogAction action taken when watchdog timer expires.

2.11

Example:

-> { "execute": "watchdog-set-action",
     "arguments": { "action": "inject-nmi" } }
<- { "return": {} }

Set the actions that will be taken by the emulator in response to guest events.

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.

6.0

Example:

-> { "execute": "set-action",
     "arguments": { "reboot": "shutdown",
                    "shutdown" : "pause",
                    "panic": "pause",
                    "watchdog": "inject-nmi" } }
<- { "return": {} }

Emitted when guest OS panic is detected

action: GuestPanicAction

action that has been taken, currently always "pause"

info: GuestPanicInformation (optional)

information about a panic (since 2.9)

1.5

Example:

<- { "event": "GUEST_PANICKED",
     "data": { "action": "pause" },
     "timestamp": { "seconds": 1648245231, "microseconds": 900001 } }

Emitted when guest OS crash loaded is detected

action: GuestPanicAction

action that has been taken, currently always "run"

info: GuestPanicInformation (optional)

information about a panic

5.0

Example:

<- { "event": "GUEST_CRASHLOADED",
     "data": { "action": "run" },
     "timestamp": { "seconds": 1648245259, "microseconds": 893771 } }

Emitted when guest submits a shutdown request via pvpanic interface

9.1

Example:

<- { "event": "GUEST_PVSHUTDOWN",
     "timestamp": { "seconds": 1648245259, "microseconds": 893771 } }

An enumeration of the actions taken when guest OS panic is detected

pause

system pauses

poweroff

system powers off (since 2.8)

run

system continues to run (since 5.0)

2.1

An enumeration of the guest panic information types

hyper-v

hyper-v guest panic information type

s390

s390 guest panic information type (Since: 2.12)

2.9

Information about a guest panic

type: GuestPanicInformationType

Crash type that defines the hypervisor specific information

The members of GuestPanicInformationHyperV when type is "hyper-v"

The members of GuestPanicInformationS390 when type is "s390"

2.9

Hyper-V specific guest panic information (HV crash MSRs)

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.

2.9

Reason why the CPU is in a crashed state.

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

2.12

S390 specific guest panic information (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

2.12

Emitted when a memory failure occurs on host side.

recipient: MemoryFailureRecipient

recipient is defined as MemoryFailureRecipient.

action: MemoryFailureAction

action that has been taken.

flags: MemoryFailureFlags

flags for MemoryFailureAction.

5.2

Example:

<- { "event": "MEMORY_FAILURE",
     "data": { "recipient": "hypervisor",
               "action": "fatal",
               "flags": { "action-required": false,
                          "recursive": false } },
     "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }

Hardware memory failure occurs, handled by recipient.

hypervisor

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

guest

memory failure at guest memory,

5.2

Actions taken by QEMU in response to a hardware memory failure.

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.

5.2

Additional information on 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.

5.2

An enumeration of the options specified when enabling notify VM exit

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.

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

sm3

SM3. (since 9.2.0)

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

sm4

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

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

2.6

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

The members of QCryptoBlockOptionsBase

The members of QCryptoBlockOptionsQCow when format is "qcow"

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

The members of QCryptoBlockOptionsQCow when format is "qcow"

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: 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: array of QCryptoBlockInfoLUKSSlot

information about each key slot

2.7

Information about the block encryption options

The members of QCryptoBlockInfoBase

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

5.1

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

The members of QCryptoBlockOptionsBase

The members of QCryptoBlockAmendOptionsLUKS when format is "luks"

5.1

Properties for objects of classes derived from secret-common.

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.

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

CONFIG_SECRET_KEYRING

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.

The members of TlsCredsProperties

2.5

Properties for tls-creds-psk objects.

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

3.0

Properties for tls-creds-x509 objects.

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

2.5

The supported algorithms for asymmetric encryption ciphers

rsa

RSA algorithm

7.1

The type of asymmetric keys.

public

public key

private

private key

7.1

The padding algorithm for RSA.

raw

no padding used

pkcs1

pkcs1#v1.5

7.1

Specific parameters for RSA algorithm.

hash-alg: QCryptoHashAlgo

QCryptoHashAlgo

padding-alg: QCryptoRSAPaddingAlgo

QCryptoRSAPaddingAlgo

7.1

The options that are available for all asymmetric key algorithms when creating a new QCryptoAkCipher.

alg: QCryptoAkCipherAlgo

encryption cipher algorithm

The members of QCryptoAkCipherOptionsRSA when alg is "rsa"

7.1

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

change

see block-job-change (since 8.2)

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: string

The job identifier.

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

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

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)

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 VmdkExtentInfo

List of extent files

1.7

Information about a VMDK extent file

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

8.0

encryption-format: RbdImageEncryptionFormat (optional)

Image encryption format

6.1

extent-size-hint: int (optional)

Extent size hint (if available)

8.0

luks

Since 2.7

rbd

Since 6.1

file

Since 8.0

qcow2

Not documented

vmdk

Not documented

1.7

data: ImageInfoSpecificQCow2

image information specific to QCOW2

1.7

data: ImageInfoSpecificVmdk

image information specific to VMDK

6.1

data: QCryptoBlockInfoLUKS

image information specific to LUKS

2.7

data: ImageInfoSpecificRbd

image information specific to RBD

6.1

data: ImageInfoSpecificFile

image information specific to files

8.0

A discriminated record of image format specific information structures.

type: ImageInfoSpecificKind

block driver name

The members of ImageInfoSpecificQCow2Wrapper when type is "qcow2"

The members of ImageInfoSpecificVmdkWrapper when type is "vmdk"

The members of ImageInfoSpecificLUKSWrapper when type is "luks"

The members of ImageInfoSpecificRbdWrapper when type is "rbd"

The members of ImageInfoSpecificFileWrapper when type is "file"

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

format-specific: ImageInfoSpecific (optional)

structure supplying additional format-specific information (since 1.7)

8.0

Information about a QEMU image file, and potentially its backing image

backing-image: ImageInfo (optional)

info of the backing image

The members of BlockNodeInfo

1.3

Information about all nodes in the block graph starting at some node, annotated with information about that node in relation to its parent.

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

8.0

Information about all nodes in a block (sub)graph in the form of BlockNodeInfo data.  The base BlockNodeInfo struct contains the information for the (sub)graph's root node.

children: array of BlockChildInfo

Array of links to this node's child nodes' information

The members of BlockNodeInfo

8.0

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

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

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

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, one more element than boundaries has.  For the example above, bins may be something like [3, 1, 5, 2], and corresponding histogram looks like:

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

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)

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

Example:

-> { "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"
         }
      ]
   }

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

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.

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: array of 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)

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

block driver name

The members of BlockStatsSpecificFile when driver is "file"

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

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

Example:

-> { "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
            }
         }
      ]
   }

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 specific to mirror block jobs.

actively-synced: boolean

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

8.2

Information about a long-running block device operation.

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)

The members of BlockJobInfoMirror when type is "mirror"

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

• If device is not a valid block device, DeviceNotFound

0.14

Example:

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

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.

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)

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)

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.

NOTE:

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.

The members of BlockdevSnapshotSync

• If device is not a valid block device, DeviceNotFound

0.14

Example:

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

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.

The members 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

Example:

-> { "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": {} }

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.

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

backing-mask-protocol: boolean (optional)

If true, replace any protocol mentioned in the 'backing file format' with 'raw', rather than storing the protocol name as the backing format.  Can be used even when no image header will be updated (default false; since 9.0).

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.

• If device does not exist, DeviceNotFound

1.3

Example:

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

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.

• If device is not a valid block device, GenericError

1.6

Example:

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

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

• If device is not a valid block device, DeviceNotFound

2.3

Example:

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

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

Example:

-> { "execute": "query-named-block-nodes" }
<- { "return": [ { "ro":false,
                   "drv":"qcow2",
                   "encrypted":false,
                   "file":"disks/test.qcow2",
                   "node-name": "my-node",
                   "backing_file_depth":1,
                   "detect_zeroes":"off",
                   "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
                      }
                   } } ] }

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

4.0

Enum of base block permissions.

consistent-read

A user that has the "permission" of consistent reads is guaranteed that their view of the contents of the block device is complete and self-consistent, representing the contents of a disk at a specific point.  For most block devices (including their backing files) this is true, but the property cannot be maintained in a few situations like for intermediate nodes of a commit block job.

write

This permission is required to change the visible disk contents.

write-unchanged

This permission (which is weaker than BLK_PERM_WRITE) is both enough and required for writes to the block node when the caller promises that the visible disk content doesn't change.  As the BLK_PERM_WRITE permission is strictly stronger, either is sufficient to perform an unchanging write.

resize

This permission is required to change the size of a block node.

4.0

Block Graph edge description for x-debug-query-block-graph.

parent: int

parent id

child: int

child id

name: string

name of the relation (examples are 'file' and 'backing')

perm: array of BlockPermission

granted permissions for the parent operating on the child

shared-perm: array of BlockPermission

permissions that can still be granted to other users of the child while it is still attached to this parent

4.0

Block Graph - list of nodes and list of edges.

nodes: array of XDbgBlockGraphNode

Not documented

edges: array of XDbgBlockGraphEdge

Not documented

4.0

Get the block graph.

unstable

This command is meant for debugging.

4.0

Start mirroring a block device's writes to a new destination. target specifies the target of the new image.  If the file exists, or if it is a device, it will be used as the new destination for writes.  If it does not exist, a new file will be created.  format specifies the format of the mirror image, default is to probe if mode='existing', else the format of the source.

The members of DriveMirror

• If device is not a valid block device, GenericError

1.3

Example:

-> { "execute": "drive-mirror",
     "arguments": { "device": "ide-hd0",
                    "target": "/some/place/my-image",
                    "sync": "full",
                    "format": "qcow2" } }
<- { "return": {} }

A set of parameters describing drive mirror setup.

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 whose writes should be mirrored.

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

node-name: string (optional)

the new block driver state node name in the graph (Since 2.1)

replaces: string (optional)

with sync=full graph node name to be replaced by the new image when a whole image copy is done.  This can be used to repair broken Quorum files.  By default, device is replaced, although implicitly created filters on it are kept.  (Since 2.1)

mode: NewImageMode (optional)

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

speed: int (optional)

the maximum speed, in bytes per second

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, or only new I/O).

granularity: int (optional)

granularity of the dirty bitmap, default is 64K if the image format doesn't have clusters, 4K if the clusters are smaller than that, else the cluster size.  Must be a power of 2 between 512 and 64M (since 1.4).

buf-size: int (optional)

maximum amount of data in flight from source to target (since 1.4).

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

unmap: boolean (optional)

Whether to try to unmap target sectors where source has only zero.  If true, and target unallocated sectors will read as zero, target image sectors will be unmapped; otherwise, zeroes will be written.  Both will result in identical contents. Default is true.  (Since 2.4)

copy-mode: MirrorCopyMode (optional)

when to copy data to the destination; defaults to 'background' (Since: 3.0)

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)

1.3

node: string

name of device/node which the bitmap is tracking

name: string

name of the dirty bitmap

2.4

node: string

name of device/node which the bitmap is tracking

name: string

name of the dirty bitmap (must be less than 1024 bytes)

granularity: int (optional)

the bitmap granularity, default is 64k for block-dirty-bitmap-add

persistent: boolean (optional)

the bitmap is persistent, i.e. it will be saved to the corresponding block device image file on its close.  For now only Qcow2 disks support persistent bitmaps.  Default is false for block-dirty-bitmap-add.  (Since: 2.10)

disabled: boolean (optional)

the bitmap is created in the disabled state, which means that it will not track drive changes.  The bitmap may be enabled with block-dirty-bitmap-enable.  Default is false.  (Since: 4.0)

2.4

local: string

name of the bitmap, attached to the same node as target bitmap.

external: BlockDirtyBitmap

bitmap with specified node

4.1

node: string

name of device/node which the target bitmap is tracking

target: string

name of the destination dirty bitmap

bitmaps: array of BlockDirtyBitmapOrStr

name(s) of the source dirty bitmap(s) at node and/or fully specified BlockDirtyBitmap elements.  The latter are supported since 4.1.

4.0

Create a dirty bitmap with a name on the node, and start tracking the writes.

The members of BlockDirtyBitmapAdd

• If node is not a valid block device or node, DeviceNotFound
• If name is already taken, GenericError

2.4

Example:

-> { "execute": "block-dirty-bitmap-add",
     "arguments": { "node": "drive0", "name": "bitmap0" } }
<- { "return": {} }

Stop write tracking and remove the dirty bitmap that was created with block-dirty-bitmap-add.  If the bitmap is persistent, remove it from its storage too.

The members of BlockDirtyBitmap

• If node is not a valid block device or node, DeviceNotFound
• If name is not found, GenericError
• if name is frozen by an operation, GenericError

2.4

Example:

-> { "execute": "block-dirty-bitmap-remove",
     "arguments": { "node": "drive0", "name": "bitmap0" } }
<- { "return": {} }

Clear (reset) a dirty bitmap on the device, so that an incremental backup from this point in time forward will only backup clusters modified after this clear operation.

The members of BlockDirtyBitmap

• If node is not a valid block device, DeviceNotFound
• If name is not found, GenericError

2.4

Example:

-> { "execute": "block-dirty-bitmap-clear",
     "arguments": { "node": "drive0", "name": "bitmap0" } }
<- { "return": {} }

Enables a dirty bitmap so that it will begin tracking disk changes.

The members of BlockDirtyBitmap

• If node is not a valid block device, DeviceNotFound
• If name is not found, GenericError

4.0

Example:

-> { "execute": "block-dirty-bitmap-enable",
     "arguments": { "node": "drive0", "name": "bitmap0" } }
<- { "return": {} }

Disables a dirty bitmap so that it will stop tracking disk changes.

The members of BlockDirtyBitmap

• If node is not a valid block device, DeviceNotFound
• If name is not found, GenericError

4.0

Example:

-> { "execute": "block-dirty-bitmap-disable",
     "arguments": { "node": "drive0", "name": "bitmap0" } }
<- { "return": {} }

Merge dirty bitmaps listed in bitmaps to the target dirty bitmap. Dirty bitmaps in bitmaps will be unchanged, except if it also appears as the target bitmap.  Any bits already set in target will still be set after the merge, i.e., this operation does not clear the target.  On error, target is unchanged.

The resulting bitmap will count as dirty any clusters that were dirty in any of the source bitmaps.  This can be used to achieve backup checkpoints, or in simpler usages, to copy bitmaps.

The members of BlockDirtyBitmapMerge

• If node is not a valid block device, DeviceNotFound
• If any bitmap in bitmaps or target is not found, GenericError
• If any of the bitmaps have different sizes or granularities, GenericError

4.0

Example:

-> { "execute": "block-dirty-bitmap-merge",
     "arguments": { "node": "drive0", "target": "bitmap0",
                    "bitmaps": ["bitmap1"] } }
<- { "return": {} }

SHA256 hash of dirty bitmap data

sha256: string

ASCII representation of SHA256 bitmap hash

2.10

Get bitmap SHA256.

The members of BlockDirtyBitmap

unstable

This command is meant for debugging.

BlockDirtyBitmapSha256

• If node is not a valid block device, DeviceNotFound
• If name is not found or if hashing has failed, GenericError

2.10

Start mirroring a block device's writes to a new destination.

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 whose writes should be mirrored.

target: string

the id or node-name of the block device to mirror to.  This mustn't be attached to guest.

replaces: string (optional)

with sync=full graph node name to be replaced by the new image when a whole image copy is done.  This can be used to repair broken Quorum files.  By default, device is replaced, although implicitly created filters on it are kept.

speed: int (optional)

the maximum speed, in bytes per second

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, or only new I/O).

granularity: int (optional)

granularity of the dirty bitmap, default is 64K if the image format doesn't have clusters, 4K if the clusters are smaller than that, else the cluster size.  Must be a power of 2 between 512 and 64M

buf-size: int (optional)

maximum amount of data in flight from source to target

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

filter-node-name: string (optional)

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

copy-mode: MirrorCopyMode (optional)

when to copy data to the destination; defaults to 'background' (Since: 3.0)

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)

2.6

Example:

-> { "execute": "blockdev-mirror",
     "arguments": { "device": "ide-hd0",
                    "target": "target0",
                    "sync": "full" } }
<- { "return": {} }

A set of parameters describing block throttling.

device: string (optional)

Block device name

id: string (optional)

The name or QOM path of the guest device (since: 2.8)

bps: int

total throughput limit in bytes per second

bps_rd: int

read throughput limit in bytes per second

bps_wr: int

write throughput limit in bytes per second

iops: int

total I/O operations per second

iops_rd: int

read I/O operations per second

iops_wr: int

write I/O operations per second

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.  It must only be set if bps_max is set as well. Defaults to 1.  (Since 2.6)

bps_rd_max_length: int (optional)

maximum length of the bps_rd_max burst period, in seconds.  It must only be set if bps_rd_max is set as well. Defaults to 1.  (Since 2.6)

bps_wr_max_length: int (optional)

maximum length of the bps_wr_max burst period, in seconds.  It must only be set if bps_wr_max is set as well. Defaults to 1.  (Since 2.6)

iops_max_length: int (optional)

maximum length of the iops burst period, in seconds.  It must only be set if iops_max is set as well. Defaults to 1.  (Since 2.6)

iops_rd_max_length: int (optional)

maximum length of the iops_rd_max burst period, in seconds.  It must only be set if iops_rd_max is set as well.  Defaults to 1.  (Since 2.6)

iops_wr_max_length: int (optional)

maximum length of the iops_wr_max burst period, in seconds.  It must only be set if iops_wr_max is set as well.  Defaults to 1.  (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)

deprecated

Member device is deprecated.  Use id instead.

1.1

Limit parameters for throttling.  Since some limit combinations are illegal, limits should always be set in one transaction.  All fields are optional.  When setting limits, if a field is missing the current value is not changed.

iops-total: int (optional)

limit total I/O operations per second

iops-total-max: int (optional)

I/O operations burst

iops-total-max-length: int (optional)

length of the iops-total-max burst period, in seconds It must only be set if iops-total-max is set as well.

iops-read: int (optional)

limit read operations per second

iops-read-max: int (optional)

I/O operations read burst

iops-read-max-length: int (optional)

length of the iops-read-max burst period, in seconds It must only be set if iops-read-max is set as well.

iops-write: int (optional)

limit write operations per second

iops-write-max: int (optional)

I/O operations write burst

iops-write-max-length: int (optional)

length of the iops-write-max burst period, in seconds It must only be set if iops-write-max is set as well.

bps-total: int (optional)

limit total bytes per second

bps-total-max: int (optional)

total bytes burst

bps-total-max-length: int (optional)

length of the bps-total-max burst period, in seconds.  It must only be set if bps-total-max is set as well.

bps-read: int (optional)

limit read bytes per second

bps-read-max: int (optional)

total bytes read burst

bps-read-max-length: int (optional)

length of the bps-read-max burst period, in seconds It must only be set if bps-read-max is set as well.

bps-write: int (optional)

limit write bytes per second

bps-write-max: int (optional)

total bytes write burst

bps-write-max-length: int (optional)

length of the bps-write-max burst period, in seconds It must only be set if bps-write-max is set as well.

iops-size: int (optional)

when limiting by iops max size of an I/O in bytes

2.11

Properties for throttle-group objects.

limits: ThrottleLimits (optional)

limits to apply for this throttle group

x-iops-total: int (optional)

Not documented

x-iops-total-max: int (optional)

Not documented

x-iops-total-max-length: int (optional)

Not documented

x-iops-read: int (optional)

Not documented

x-iops-read-max: int (optional)

Not documented

x-iops-read-max-length: int (optional)

Not documented

x-iops-write: int (optional)

Not documented

x-iops-write-max: int (optional)

Not documented

x-iops-write-max-length: int (optional)

Not documented

x-bps-total: int (optional)

Not documented

x-bps-total-max: int (optional)

Not documented

x-bps-total-max-length: int (optional)

Not documented

x-bps-read: int (optional)

Not documented

x-bps-read-max: int (optional)

Not documented

x-bps-read-max-length: int (optional)

Not documented

x-bps-write: int (optional)

Not documented

x-bps-write-max: int (optional)

Not documented

x-bps-write-max-length: int (optional)

Not documented

x-iops-size: int (optional)

Not documented

unstable

All members starting with x- are aliases for the same key without x- in the limits object.  This is not a stable interface and may be removed or changed incompatibly in the future.  Use limits for a supported stable interface.

2.11

Copy data from a backing file into a block device.

The block streaming operation is performed in the background until the entire backing file has been copied.  This command returns immediately once streaming has started.  The status of ongoing block streaming operations can be checked with query-block-jobs.  The operation can be stopped before it has completed using the block-job-cancel command.

The node that receives the data is called the top image, can be located in any part of the chain (but always above the base image; see below) and can be specified using its device or node name. Earlier qemu versions only allowed 'device' to name the top level node; presence of the 'base-node' parameter during introspection can be used as a witness of the enhanced semantics of 'device'.

If a base file is specified then sectors are not copied from that base file and its backing chain.  This can be used to stream a subset of the backing file chain instead of flattening the entire image.  When streaming completes the image file will have the base file as its backing file, unless that node was changed while the job was running.  In that case, base's parent's backing (or filtered, whichever exists) child (i.e., base at the beginning of the job) will be the new backing file.

On successful completion the image file is updated to drop the backing file and the BLOCK_JOB_COMPLETED event is emitted.

In case device is a filter node, block-stream modifies the first non-filter overlay node below it to point to the new backing node instead of modifying device itself.

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 or node name of the top image

base: string (optional)

the common backing file name.  It cannot be set if base-node or bottom is also set.

base-node: string (optional)

the node name of the backing file.  It cannot be set if base or bottom is also set.  (Since 2.8)

bottom: string (optional)

the last node in the chain that should be streamed into top.  It cannot be set if base or base-node is also set.  It cannot be filter node.  (Since 6.0)

backing-file: string (optional)

The backing file string to write into the top image. 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)

backing-mask-protocol: boolean (optional)

If true, replace any protocol mentioned in the 'backing file format' with 'raw', rather than storing the protocol name as the backing format.  Can be used even when no image header will be updated (default false; since 9.0).

speed: int (optional)

the maximum speed, in bytes per second

on-error: BlockdevOnError (optional)

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

filter-node-name: string (optional)

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

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)

• If device does not exist, DeviceNotFound.

1.1

Example:

-> { "execute": "block-stream",
     "arguments": { "device": "virtio0",
                    "base": "/tmp/master.qcow2" } }
<- { "return": {} }

Set maximum speed for a background block operation.

This command can only be issued when there is an active block job.

Throttling can be disabled by setting the speed to 0.

device: string

The job identifier.  This used to be a device name (hence the name of the parameter), but since QEMU 2.7 it can have other values.

speed: int

the maximum speed, in bytes per second, or 0 for unlimited. Defaults to 0.

• If no background operation is active on this device, DeviceNotActive

1.1

Stop an active background block operation.

This command returns immediately after marking the active background block operation for cancellation.  It is an error to call this command if no operation is in progress.

The operation will cancel as soon as possible and then emit the BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when enumerated using query-block-jobs.

Note that if you issue 'block-job-cancel' after 'drive-mirror' has indicated (via the event BLOCK_JOB_READY) that the source and destination are synchronized, then the event triggered by this command changes to BLOCK_JOB_COMPLETED, to indicate that the mirroring has ended and the destination now has a point-in-time copy tied to the time of the cancellation.

For streaming, the image file retains its backing file unless the streaming operation happens to complete just as it is being cancelled.  A new streaming operation can be started at a later time to finish copying all data from the backing file.

device: string

The job identifier.  This used to be a device name (hence the name of the parameter), but since QEMU 2.7 it can have other values.

force: boolean (optional)

If true, and the job has already emitted the event BLOCK_JOB_READY, abandon the job immediately (even if it is paused) instead of waiting for the destination to complete its final synchronization (since 1.3)

• If no background operation is active on this device, DeviceNotActive

1.1

Pause an active background block operation.

This command returns immediately after marking the active background block operation for pausing.  It is an error to call this command if no operation is in progress or if the job is already paused.

The operation will pause as soon as possible.  No event is emitted when the operation is actually paused.  Cancelling a paused job automatically resumes it.

device: string

The job identifier.  This used to be a device name (hence the name of the parameter), but since QEMU 2.7 it can have other values.

• If no background operation is active on this device, DeviceNotActive

1.3

Resume an active background block operation.

This command returns immediately after resuming a paused background block operation.  It is an error to call this command if no operation is in progress or if the job is not paused.

This command also clears the error status of the job.

device: string

The job identifier.  This used to be a device name (hence the name of the parameter), but since QEMU 2.7 it can have other values.

• If no background operation is active on this device, DeviceNotActive

1.3

Manually trigger completion of an active background block operation. This is supported for drive mirroring, where it also switches the device to write to the target path only.  The ability to complete is signaled with a BLOCK_JOB_READY event.

This command completes an active background block operation synchronously.  The ordering of this command's return with the BLOCK_JOB_COMPLETED event is not defined.  Note that if an I/O error occurs during the processing of this command: 1) the command itself will fail; 2) the error will be processed according to the rerror/werror arguments that were specified when starting the operation.

A cancelled or paused job cannot be completed.

device: string

The job identifier.  This used to be a device name (hence the name of the parameter), but since QEMU 2.7 it can have other values.

• If no background operation is active on this device, DeviceNotActive

1.3

For jobs that have already concluded, remove them from the block-job-query list.  This command only needs to be run for jobs which were started with QEMU 2.12+ job lifetime management semantics.

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 the BLOCK_JOB_READY event, block-job-cancel or block-job-complete will still need to be used as appropriate.

id: string

The job identifier.

2.12

Once a job that has manual=true reaches the pending state, it can be instructed to finalize any graph changes and do any necessary cleanup via this command.  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 job identifier.

2.12

copy-mode: MirrorCopyMode

Switch to this copy mode.  Currently, only the switch from 'background' to 'write-blocking' is implemented.

8.2

Block job options that can be changed after job creation.

id: string

The job identifier

type: JobType

The job type

The members of BlockJobChangeOptionsMirror when type is "mirror"

8.2

Change the block job's options.

The members of BlockJobChangeOptions

8.2

Determines how to handle discard requests.

ignore

Ignore the request

unmap

Forward as an unmap request

2.9

Describes the operation mode for the automatic conversion of plain zero writes by the OS to driver specific optimized zero write commands.

off

Disabled (default)

on

Enabled

unmap

Enabled and even try to unmap blocks if possible.  This requires also that BlockdevDiscardOptions is set to unmap for this device.

2.1

Selects the AIO backend to handle I/O requests

threads

Use qemu's thread pool

native

Use native AIO backend (only Linux and Windows)

io_uring (If: CONFIG_LINUX_IO_URING)

Use linux io_uring (since 5.0)

2.9

Includes cache-related options for block devices

direct: boolean (optional)

enables use of O_DIRECT (bypass the host page cache; default: false)

no-flush: boolean (optional)

ignore any flush requests for the device (default: false)

2.9

Drivers that are supported in block device operations.

throttle

Since 2.11

nvme

Since 2.12

copy-on-read

Since 3.0

blklogwrites

Since 3.0

blkreplay

Since 4.2

compress

Since 5.0

copy-before-write

Since 6.2

snapshot-access

Since 7.0

blkdebug

Not documented

blkverify

Not documented

bochs

Not documented

cloop

Not documented

dmg

Not documented

file

Not documented

ftp

Not documented

ftps

Not documented

gluster

Not documented

host_cdrom (If: HAVE_HOST_BLOCK_DEVICE)

Not documented

host_device (If: HAVE_HOST_BLOCK_DEVICE)

Not documented

http

Not documented

https

Not documented

io_uring (If: CONFIG_BLKIO)

Not documented

iscsi

Not documented

luks

Not documented

nbd

Not documented

nfs

Not documented

null-aio

Not documented

null-co

Not documented

nvme-io_uring (If: CONFIG_BLKIO)

Not documented

parallels

Not documented

preallocate

Not documented

qcow

Not documented

qcow2

Not documented

qed

Not documented

quorum

Not documented

raw

Not documented

rbd

Not documented

replication (If: CONFIG_REPLICATION)

Not documented

ssh

Not documented

vdi

Not documented

vhdx

Not documented

virtio-blk-vfio-pci (If: CONFIG_BLKIO)

Not documented

virtio-blk-vhost-user (If: CONFIG_BLKIO)

Not documented

virtio-blk-vhost-vdpa (If: CONFIG_BLKIO)

Not documented

vmdk

Not documented

vpc

Not documented

vvfat

Not documented

deprecated

Member gluster is deprecated because GlusterFS development ceased.

2.9

Driver specific block device options for the file backend.

filename: string

path to the image file

pr-manager: string (optional)

the id for the object that will handle persistent reservations for this device (default: none, forward the commands via SG_IO; since 2.11)

aio: BlockdevAioOptions (optional)

AIO backend (default: threads) (since: 2.8)

aio-max-batch: int (optional)

maximum number of requests to batch together into a single submission in the AIO backend.  The smallest value between this and the aio-max-batch value of the IOThread object is chosen.  0 means that the AIO backend will handle it automatically.  (default: 0, since 6.2)

locking: OnOffAuto (optional)

whether to enable file locking.  If set to 'auto', only enable when Open File Descriptor (OFD) locking API is available (default: auto, since 2.10)

drop-cache: boolean (optional) (If: CONFIG_LINUX)

invalidate page cache during live migration.  This prevents stale data on the migration destination with cache.direct=off.  Currently only supported on Linux hosts. (default: on, since: 4.0)

x-check-cache-dropped: boolean (optional)

whether to check that page cache was dropped on live migration.  May cause noticeable delays if the image file is large, do not use in production.  (default: off) (since: 3.0)

dynamic-auto-read-only

If present, enabled auto-read-only means that the driver will open the image read-only at first, dynamically reopen the image file read-write when the first writer is attached to the node and reopen read-only when the last writer is detached.  This allows giving QEMU write permissions only on demand when an operation actually needs write access.

unstable

Member x-check-cache-dropped is meant for debugging.

2.9

Driver specific block device options for the null backend.

size: int (optional)

size of the device in bytes.

latency-ns: int (optional)

emulated latency (in nanoseconds) in processing requests.  Default to zero which completes requests immediately. (Since 2.4)

read-zeroes: boolean (optional)

if true, reads from the device produce zeroes; if false, the buffer is left unchanged. (default: false; since: 4.1)

2.9

Driver specific block device options for the NVMe backend.

device: string

PCI controller address of the NVMe device in format hhhh:bb:ss.f (host:bus:slot.function)

namespace: int

namespace number of the device, starting from 1.

Note that the PCI device must have been unbound from any host kernel driver before instructing QEMU to add the blockdev.

2.12

Driver specific block device options for the vvfat protocol.

dir: string

directory to be exported as FAT image

fat-type: int (optional)

FAT type: 12, 16 or 32

floppy: boolean (optional)

whether to export a floppy image (true) or partitioned hard disk (false; default)

label: string (optional)

set the volume label, limited to 11 bytes.  FAT16 and FAT32 traditionally have some restrictions on labels, which are ignored by most operating systems.  Defaults to "QEMU VVFAT". (since 2.4)

rw: boolean (optional)

whether to allow write operations (default: false)

2.9

Driver specific block device options for image format that have no option besides their data source.

file: BlockdevRef

reference to or definition of the data source block device

2.9

Driver specific block device options for LUKS.

key-secret: string (optional)

the ID of a QCryptoSecret object providing the decryption key (since 2.6).  Mandatory except when doing a metadata-only probe of the image.

header: BlockdevRef (optional)

block device holding a detached LUKS header.  (since 9.0)

The members of BlockdevOptionsGenericFormat

2.9

Driver specific block device options for image format that have no option besides their data source and an optional backing file.