One Hat Cyber Team
Your IP :
216.73.216.216
Server IP :
194.44.31.54
Server :
Linux zen.imath.kiev.ua 4.18.0-553.77.1.el8_10.x86_64 #1 SMP Fri Oct 3 14:30:23 UTC 2025 x86_64
Server Software :
Apache/2.4.37 (Rocky Linux) OpenSSL/1.1.1k
PHP Version :
5.6.40
Buat File
|
Buat Folder
Eksekusi
Dir :
~
/
usr
/
share
/
doc
/
qemu-kvm
/
interop
/
Edit File:
qemu-qmp-ref.html
<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>QEMU QMP Reference Manual — QEMU qemu-kvm-6.2.0-53.module+el8.10.0+2055+8eb7870b.4 documentation</title> <link rel="shortcut icon" href="../_static/qemu_32x32.png"/> <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="QEMU Storage Daemon QMP Reference Manual" href="qemu-storage-daemon-qmp-ref.html" /> <link rel="prev" title="QEMU Guest Agent Protocol Reference" href="qemu-ga-ref.html" /> <script src="../_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="../index.html" class="icon icon-home"> QEMU <img src="../_static/qemu_128x128.png" class="logo" alt="Logo"/> </a> <div class="version"> 6.2.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <p class="caption"><span class="caption-text">Contents:</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../about/index.html">About QEMU</a></li> <li class="toctree-l1"><a class="reference internal" href="../system/index.html">System Emulation</a></li> <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User Mode Emulation</a></li> <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Tools</a></li> <li class="toctree-l1 current"><a class="reference internal" href="index.html">System Emulation Management and Interoperability</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="barrier.html">Barrier client protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="bitmaps.html">Dirty Bitmaps and Incremental Backup</a></li> <li class="toctree-l2"><a class="reference internal" href="dbus.html">D-Bus</a></li> <li class="toctree-l2"><a class="reference internal" href="dbus-vmstate.html">D-Bus VMState</a></li> <li class="toctree-l2"><a class="reference internal" href="live-block-operations.html">Live Block Device Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="pr-helper.html">Persistent reservation helper protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="qemu-ga.html">QEMU Guest Agent</a></li> <li class="toctree-l2"><a class="reference internal" href="qemu-ga-ref.html">QEMU Guest Agent Protocol Reference</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">QEMU QMP Reference Manual</a><ul> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-0">Introduction</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1">This document describes all commands currently supported by QMP.</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2">Stability Considerations</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-3">The current QMP command set (described in this file) may be useful for a number of use cases, however it’s limited and several commands have bad defined semantics, specially with regard to command completion.</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-4">QMP errors</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-7"><code class="docutils literal notranslate"><span class="pre">QapiErrorClass</span></code> (Enum)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-8">Common data types</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-11"><code class="docutils literal notranslate"><span class="pre">IoOperationType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-14"><code class="docutils literal notranslate"><span class="pre">OnOffAuto</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-17"><code class="docutils literal notranslate"><span class="pre">OnOffSplit</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-20"><code class="docutils literal notranslate"><span class="pre">String</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-23"><code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (Alternate)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-26"><code class="docutils literal notranslate"><span class="pre">OffAutoPCIBAR</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-29"><code class="docutils literal notranslate"><span class="pre">PCIELinkSpeed</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-32"><code class="docutils literal notranslate"><span class="pre">PCIELinkWidth</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-35"><code class="docutils literal notranslate"><span class="pre">HostMemPolicy</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-38"><code class="docutils literal notranslate"><span class="pre">NetFilterDirection</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-41"><code class="docutils literal notranslate"><span class="pre">GrabToggleKeys</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-44"><code class="docutils literal notranslate"><span class="pre">HumanReadableText</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-45">Socket data types</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-48"><code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-50"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressBase</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-53"><code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-56"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddress</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-60"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddress</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-63"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-66"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddressWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-69"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddressWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-72"><code class="docutils literal notranslate"><span class="pre">StringWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-76"><code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-79"><code class="docutils literal notranslate"><span class="pre">SocketAddressType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-82"><code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-83">VM run state</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-85"><code class="docutils literal notranslate"><span class="pre">RunState</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-87"><code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-91"><code class="docutils literal notranslate"><span class="pre">StatusInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-95"><code class="docutils literal notranslate"><span class="pre">query-status</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-100"><code class="docutils literal notranslate"><span class="pre">SHUTDOWN</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-103"><code class="docutils literal notranslate"><span class="pre">POWERDOWN</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-107"><code class="docutils literal notranslate"><span class="pre">RESET</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-110"><code class="docutils literal notranslate"><span class="pre">STOP</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-113"><code class="docutils literal notranslate"><span class="pre">RESUME</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-116"><code class="docutils literal notranslate"><span class="pre">SUSPEND</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-120"><code class="docutils literal notranslate"><span class="pre">SUSPEND_DISK</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-123"><code class="docutils literal notranslate"><span class="pre">WAKEUP</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-129"><code class="docutils literal notranslate"><span class="pre">WATCHDOG</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-132"><code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-135"><code class="docutils literal notranslate"><span class="pre">RebootAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-138"><code class="docutils literal notranslate"><span class="pre">ShutdownAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-141"><code class="docutils literal notranslate"><span class="pre">PanicAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-144"><code class="docutils literal notranslate"><span class="pre">watchdog-set-action</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-149"><code class="docutils literal notranslate"><span class="pre">set-action</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-153"><code class="docutils literal notranslate"><span class="pre">GUEST_PANICKED</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-157"><code class="docutils literal notranslate"><span class="pre">GUEST_CRASHLOADED</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-160"><code class="docutils literal notranslate"><span class="pre">GuestPanicAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-163"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-166"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformation</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-169"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationHyperV</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-172"><code class="docutils literal notranslate"><span class="pre">S390CrashReason</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-175"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationS390</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-179"><code class="docutils literal notranslate"><span class="pre">MEMORY_FAILURE</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-182"><code class="docutils literal notranslate"><span class="pre">MemoryFailureRecipient</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-185"><code class="docutils literal notranslate"><span class="pre">MemoryFailureAction</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-188"><code class="docutils literal notranslate"><span class="pre">MemoryFailureFlags</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-189">Cryptography</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-192"><code class="docutils literal notranslate"><span class="pre">QCryptoTLSCredsEndpoint</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-195"><code class="docutils literal notranslate"><span class="pre">QCryptoSecretFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-198"><code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-201"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-204"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-207"><code class="docutils literal notranslate"><span class="pre">QCryptoIVGenAlgorithm</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-210"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-213"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-216"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-219"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-222"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptionsLUKS</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-225"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOpenOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-228"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-231"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoBase</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-234"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKSSlot</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-237"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-240"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-243"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockLUKSKeyslotState</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-246"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptionsLUKS</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-249"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-253"><code class="docutils literal notranslate"><span class="pre">SecretCommonProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-256"><code class="docutils literal notranslate"><span class="pre">SecretProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-259"><code class="docutils literal notranslate"><span class="pre">SecretKeyringProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-262"><code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-266"><code class="docutils literal notranslate"><span class="pre">TlsCredsAnonProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-270"><code class="docutils literal notranslate"><span class="pre">TlsCredsPskProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-274"><code class="docutils literal notranslate"><span class="pre">TlsCredsX509Properties</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-275">Block devices</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-276">Block core (VM unrelated)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-277">Background jobs</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-998">Additional block stuff (VM related)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1065">Block device exports</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1130">Character devices</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1134"><code class="docutils literal notranslate"><span class="pre">ChardevInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1138"><code class="docutils literal notranslate"><span class="pre">query-chardev</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1141"><code class="docutils literal notranslate"><span class="pre">ChardevBackendInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1145"><code class="docutils literal notranslate"><span class="pre">query-chardev-backends</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1148"><code class="docutils literal notranslate"><span class="pre">DataFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1153"><code class="docutils literal notranslate"><span class="pre">ringbuf-write</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1158"><code class="docutils literal notranslate"><span class="pre">ringbuf-read</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1161"><code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1164"><code class="docutils literal notranslate"><span class="pre">ChardevFile</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1167"><code class="docutils literal notranslate"><span class="pre">ChardevHostdev</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1170"><code class="docutils literal notranslate"><span class="pre">ChardevSocket</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1173"><code class="docutils literal notranslate"><span class="pre">ChardevUdp</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1176"><code class="docutils literal notranslate"><span class="pre">ChardevMux</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1179"><code class="docutils literal notranslate"><span class="pre">ChardevStdio</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1183"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannel</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1187"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePort</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1190"><code class="docutils literal notranslate"><span class="pre">ChardevVC</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1193"><code class="docutils literal notranslate"><span class="pre">ChardevRingbuf</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1197"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgent</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1200"><code class="docutils literal notranslate"><span class="pre">ChardevBackendKind</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1203"><code class="docutils literal notranslate"><span class="pre">ChardevFileWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1206"><code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1209"><code class="docutils literal notranslate"><span class="pre">ChardevSocketWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1212"><code class="docutils literal notranslate"><span class="pre">ChardevUdpWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1215"><code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1218"><code class="docutils literal notranslate"><span class="pre">ChardevMuxWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1221"><code class="docutils literal notranslate"><span class="pre">ChardevStdioWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1225"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannelWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1229"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePortWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1233"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgentWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1236"><code class="docutils literal notranslate"><span class="pre">ChardevVCWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1239"><code class="docutils literal notranslate"><span class="pre">ChardevRingbufWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1242"><code class="docutils literal notranslate"><span class="pre">ChardevBackend</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1245"><code class="docutils literal notranslate"><span class="pre">ChardevReturn</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1250"><code class="docutils literal notranslate"><span class="pre">chardev-add</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1255"><code class="docutils literal notranslate"><span class="pre">chardev-change</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1260"><code class="docutils literal notranslate"><span class="pre">chardev-remove</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1265"><code class="docutils literal notranslate"><span class="pre">chardev-send-break</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1270"><code class="docutils literal notranslate"><span class="pre">VSERPORT_CHANGE</span></code> (Event)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1271">Dump guest memory</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1274"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1280"><code class="docutils literal notranslate"><span class="pre">dump-guest-memory</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1283"><code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1286"><code class="docutils literal notranslate"><span class="pre">DumpQueryResult</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1290"><code class="docutils literal notranslate"><span class="pre">query-dump</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1294"><code class="docutils literal notranslate"><span class="pre">DUMP_COMPLETED</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1297"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryCapability</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1301"><code class="docutils literal notranslate"><span class="pre">query-dump-guest-memory-capability</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1302">Net devices</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1308"><code class="docutils literal notranslate"><span class="pre">set_link</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1313"><code class="docutils literal notranslate"><span class="pre">netdev_add</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1318"><code class="docutils literal notranslate"><span class="pre">netdev_del</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1321"><code class="docutils literal notranslate"><span class="pre">NetLegacyNicOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1324"><code class="docutils literal notranslate"><span class="pre">NetdevUserOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1327"><code class="docutils literal notranslate"><span class="pre">NetdevTapOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1330"><code class="docutils literal notranslate"><span class="pre">NetdevSocketOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1333"><code class="docutils literal notranslate"><span class="pre">NetdevL2TPv3Options</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1336"><code class="docutils literal notranslate"><span class="pre">NetdevVdeOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1339"><code class="docutils literal notranslate"><span class="pre">NetdevBridgeOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1342"><code class="docutils literal notranslate"><span class="pre">NetdevHubPortOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1345"><code class="docutils literal notranslate"><span class="pre">NetdevNetmapOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1348"><code class="docutils literal notranslate"><span class="pre">NetdevVhostUserOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1351"><code class="docutils literal notranslate"><span class="pre">NetdevVhostVDPAOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1354"><code class="docutils literal notranslate"><span class="pre">NetClientDriver</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1357"><code class="docutils literal notranslate"><span class="pre">Netdev</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1360"><code class="docutils literal notranslate"><span class="pre">RxState</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1363"><code class="docutils literal notranslate"><span class="pre">RxFilterInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1368"><code class="docutils literal notranslate"><span class="pre">query-rx-filter</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1372"><code class="docutils literal notranslate"><span class="pre">NIC_RX_FILTER_CHANGED</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1375"><code class="docutils literal notranslate"><span class="pre">AnnounceParameters</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1379"><code class="docutils literal notranslate"><span class="pre">announce-self</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1383"><code class="docutils literal notranslate"><span class="pre">FAILOVER_NEGOTIATED</span></code> (Event)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1384">RDMA device</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1389"><code class="docutils literal notranslate"><span class="pre">RDMA_GID_STATUS_CHANGED</span></code> (Event)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1390">Rocker switch device</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1393"><code class="docutils literal notranslate"><span class="pre">RockerSwitch</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1398"><code class="docutils literal notranslate"><span class="pre">query-rocker</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1401"><code class="docutils literal notranslate"><span class="pre">RockerPortDuplex</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1404"><code class="docutils literal notranslate"><span class="pre">RockerPortAutoneg</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1407"><code class="docutils literal notranslate"><span class="pre">RockerPort</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1412"><code class="docutils literal notranslate"><span class="pre">query-rocker-ports</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1416"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowKey</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1420"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowMask</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1424"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowAction</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1427"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlow</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1432"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-flows</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1436"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaGroup</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1441"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-groups</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1442">TPM (trusted platform module) devices</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1446"><code class="docutils literal notranslate"><span class="pre">TpmModel</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1451"><code class="docutils literal notranslate"><span class="pre">query-tpm-models</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1455"><code class="docutils literal notranslate"><span class="pre">TpmType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1460"><code class="docutils literal notranslate"><span class="pre">query-tpm-types</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1464"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1468"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1472"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptionsWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1476"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptionsWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1480"><code class="docutils literal notranslate"><span class="pre">TpmTypeOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1484"><code class="docutils literal notranslate"><span class="pre">TPMInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1489"><code class="docutils literal notranslate"><span class="pre">query-tpm</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1490">Remote desktop</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1495"><code class="docutils literal notranslate"><span class="pre">set_password</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1501"><code class="docutils literal notranslate"><span class="pre">expire_password</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1506"><code class="docutils literal notranslate"><span class="pre">screendump</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1507">Spice</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1553">VNC</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1616">Input</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1619"><code class="docutils literal notranslate"><span class="pre">MouseInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1623"><code class="docutils literal notranslate"><span class="pre">query-mice</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1627"><code class="docutils literal notranslate"><span class="pre">QKeyCode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1630"><code class="docutils literal notranslate"><span class="pre">KeyValueKind</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1633"><code class="docutils literal notranslate"><span class="pre">IntWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1636"><code class="docutils literal notranslate"><span class="pre">QKeyCodeWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1639"><code class="docutils literal notranslate"><span class="pre">KeyValue</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1644"><code class="docutils literal notranslate"><span class="pre">send-key</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1647"><code class="docutils literal notranslate"><span class="pre">InputButton</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1650"><code class="docutils literal notranslate"><span class="pre">InputAxis</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1653"><code class="docutils literal notranslate"><span class="pre">InputKeyEvent</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1656"><code class="docutils literal notranslate"><span class="pre">InputBtnEvent</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1659"><code class="docutils literal notranslate"><span class="pre">InputMoveEvent</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1662"><code class="docutils literal notranslate"><span class="pre">InputEventKind</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1665"><code class="docutils literal notranslate"><span class="pre">InputKeyEventWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1668"><code class="docutils literal notranslate"><span class="pre">InputBtnEventWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1671"><code class="docutils literal notranslate"><span class="pre">InputMoveEventWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1674"><code class="docutils literal notranslate"><span class="pre">InputEvent</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1680"><code class="docutils literal notranslate"><span class="pre">input-send-event</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1683"><code class="docutils literal notranslate"><span class="pre">DisplayGTK</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1686"><code class="docutils literal notranslate"><span class="pre">DisplayEGLHeadless</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1689"><code class="docutils literal notranslate"><span class="pre">DisplayGLMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1692"><code class="docutils literal notranslate"><span class="pre">DisplayCurses</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1695"><code class="docutils literal notranslate"><span class="pre">DisplayType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1698"><code class="docutils literal notranslate"><span class="pre">DisplayOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1701"><code class="docutils literal notranslate"><span class="pre">query-display-options</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1704"><code class="docutils literal notranslate"><span class="pre">DisplayReloadType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1707"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptionsVNC</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1710"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1715"><code class="docutils literal notranslate"><span class="pre">display-reload</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1716">User authorization</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1719"><code class="docutils literal notranslate"><span class="pre">QAuthZListPolicy</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1722"><code class="docutils literal notranslate"><span class="pre">QAuthZListFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1725"><code class="docutils literal notranslate"><span class="pre">QAuthZListRule</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1728"><code class="docutils literal notranslate"><span class="pre">AuthZListProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1731"><code class="docutils literal notranslate"><span class="pre">AuthZListFileProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1734"><code class="docutils literal notranslate"><span class="pre">AuthZPAMProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1737"><code class="docutils literal notranslate"><span class="pre">AuthZSimpleProperties</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1738">Migration</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1741"><code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1744"><code class="docutils literal notranslate"><span class="pre">XBZRLECacheStats</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1747"><code class="docutils literal notranslate"><span class="pre">CompressionStats</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1750"><code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1753"><code class="docutils literal notranslate"><span class="pre">VfioStats</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1756"><code class="docutils literal notranslate"><span class="pre">MigrationInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1760"><code class="docutils literal notranslate"><span class="pre">query-migrate</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1764"><code class="docutils literal notranslate"><span class="pre">MigrationCapability</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1767"><code class="docutils literal notranslate"><span class="pre">MigrationCapabilityStatus</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1771"><code class="docutils literal notranslate"><span class="pre">migrate-set-capabilities</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1775"><code class="docutils literal notranslate"><span class="pre">query-migrate-capabilities</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1778"><code class="docutils literal notranslate"><span class="pre">MultiFDCompression</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1781"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAliasTransform</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1784"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAlias</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1787"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationNodeAlias</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1791"><code class="docutils literal notranslate"><span class="pre">MigrationParameter</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1795"><code class="docutils literal notranslate"><span class="pre">MigrateSetParameters</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1799"><code class="docutils literal notranslate"><span class="pre">migrate-set-parameters</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1803"><code class="docutils literal notranslate"><span class="pre">MigrationParameters</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1807"><code class="docutils literal notranslate"><span class="pre">query-migrate-parameters</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1811"><code class="docutils literal notranslate"><span class="pre">client_migrate_info</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1814"><code class="docutils literal notranslate"><span class="pre">migrate-start-postcopy</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1818"><code class="docutils literal notranslate"><span class="pre">MIGRATION</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1822"><code class="docutils literal notranslate"><span class="pre">MIGRATION_PASS</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1825"><code class="docutils literal notranslate"><span class="pre">COLOMessage</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1828"><code class="docutils literal notranslate"><span class="pre">COLOMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1831"><code class="docutils literal notranslate"><span class="pre">FailoverStatus</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1835"><code class="docutils literal notranslate"><span class="pre">COLO_EXIT</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1838"><code class="docutils literal notranslate"><span class="pre">COLOExitReason</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1842"><code class="docutils literal notranslate"><span class="pre">x-colo-lost-heartbeat</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1847"><code class="docutils literal notranslate"><span class="pre">migrate_cancel</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1852"><code class="docutils literal notranslate"><span class="pre">migrate-continue</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1858"><code class="docutils literal notranslate"><span class="pre">migrate</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1864"><code class="docutils literal notranslate"><span class="pre">migrate-incoming</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1869"><code class="docutils literal notranslate"><span class="pre">xen-save-devices-state</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1874"><code class="docutils literal notranslate"><span class="pre">xen-set-global-dirty-log</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1878"><code class="docutils literal notranslate"><span class="pre">xen-load-devices-state</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1884"><code class="docutils literal notranslate"><span class="pre">xen-set-replication</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1888"><code class="docutils literal notranslate"><span class="pre">ReplicationStatus</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1893"><code class="docutils literal notranslate"><span class="pre">query-xen-replication-status</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1898"><code class="docutils literal notranslate"><span class="pre">xen-colo-do-checkpoint</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1901"><code class="docutils literal notranslate"><span class="pre">COLOStatus</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1905"><code class="docutils literal notranslate"><span class="pre">query-colo-status</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1910"><code class="docutils literal notranslate"><span class="pre">migrate-recover</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1914"><code class="docutils literal notranslate"><span class="pre">migrate-pause</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1918"><code class="docutils literal notranslate"><span class="pre">UNPLUG_PRIMARY</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1921"><code class="docutils literal notranslate"><span class="pre">DirtyRateVcpu</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1924"><code class="docutils literal notranslate"><span class="pre">DirtyRateStatus</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1927"><code class="docutils literal notranslate"><span class="pre">DirtyRateMeasureMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1930"><code class="docutils literal notranslate"><span class="pre">DirtyRateInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1934"><code class="docutils literal notranslate"><span class="pre">calc-dirty-rate</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1936"><code class="docutils literal notranslate"><span class="pre">query-dirty-rate</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1942"><code class="docutils literal notranslate"><span class="pre">snapshot-save</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1948"><code class="docutils literal notranslate"><span class="pre">snapshot-load</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1954"><code class="docutils literal notranslate"><span class="pre">snapshot-delete</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-1955">Transactions</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1957"><code class="docutils literal notranslate"><span class="pre">Abort</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1960"><code class="docutils literal notranslate"><span class="pre">ActionCompletionMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1964"><code class="docutils literal notranslate"><span class="pre">TransactionActionKind</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1967"><code class="docutils literal notranslate"><span class="pre">AbortWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1970"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAddWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1973"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1976"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMergeWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1979"><code class="docutils literal notranslate"><span class="pre">BlockdevBackupWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1982"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1985"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternalWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1988"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSyncWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1991"><code class="docutils literal notranslate"><span class="pre">DriveBackupWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1994"><code class="docutils literal notranslate"><span class="pre">TransactionAction</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-1997"><code class="docutils literal notranslate"><span class="pre">TransactionProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2003"><code class="docutils literal notranslate"><span class="pre">transaction</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2004">Tracing</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2007"><code class="docutils literal notranslate"><span class="pre">TraceEventState</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2011"><code class="docutils literal notranslate"><span class="pre">TraceEventInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2016"><code class="docutils literal notranslate"><span class="pre">trace-event-get-state</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2021"><code class="docutils literal notranslate"><span class="pre">trace-event-set-state</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2022">Compatibility policy</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2025"><code class="docutils literal notranslate"><span class="pre">CompatPolicyInput</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2028"><code class="docutils literal notranslate"><span class="pre">CompatPolicyOutput</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2031"><code class="docutils literal notranslate"><span class="pre">CompatPolicy</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2032">QMP monitor control</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2037"><code class="docutils literal notranslate"><span class="pre">qmp_capabilities</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2040"><code class="docutils literal notranslate"><span class="pre">QMPCapability</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2043"><code class="docutils literal notranslate"><span class="pre">VersionTriple</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2046"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2050"><code class="docutils literal notranslate"><span class="pre">query-version</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2053"><code class="docutils literal notranslate"><span class="pre">CommandInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2058"><code class="docutils literal notranslate"><span class="pre">query-commands</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2061"><code class="docutils literal notranslate"><span class="pre">quit</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2064"><code class="docutils literal notranslate"><span class="pre">MonitorMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2067"><code class="docutils literal notranslate"><span class="pre">MonitorOptions</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2068">QMP introspection</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2072"><code class="docutils literal notranslate"><span class="pre">query-qmp-schema</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2075"><code class="docutils literal notranslate"><span class="pre">SchemaMetaType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2079"><code class="docutils literal notranslate"><span class="pre">SchemaInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2082"><code class="docutils literal notranslate"><span class="pre">SchemaInfoBuiltin</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2085"><code class="docutils literal notranslate"><span class="pre">JSONType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2090"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnum</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2093"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnumMember</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2097"><code class="docutils literal notranslate"><span class="pre">SchemaInfoArray</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2101"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObject</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2104"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectMember</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2107"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectVariant</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2111"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternate</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2114"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternateMember</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2118"><code class="docutils literal notranslate"><span class="pre">SchemaInfoCommand</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2121"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEvent</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2122">QEMU Object Model (QOM)</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2125"><code class="docutils literal notranslate"><span class="pre">ObjectPropertyInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2130"><code class="docutils literal notranslate"><span class="pre">qom-list</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2135"><code class="docutils literal notranslate"><span class="pre">qom-get</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2139"><code class="docutils literal notranslate"><span class="pre">qom-set</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2142"><code class="docutils literal notranslate"><span class="pre">ObjectTypeInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2146"><code class="docutils literal notranslate"><span class="pre">qom-list-types</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2151"><code class="docutils literal notranslate"><span class="pre">qom-list-properties</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2154"><code class="docutils literal notranslate"><span class="pre">CanHostSocketcanProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2157"><code class="docutils literal notranslate"><span class="pre">ColoCompareProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2160"><code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2163"><code class="docutils literal notranslate"><span class="pre">CryptodevVhostUserProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2166"><code class="docutils literal notranslate"><span class="pre">DBusVMStateProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2169"><code class="docutils literal notranslate"><span class="pre">NetfilterInsert</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2172"><code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2175"><code class="docutils literal notranslate"><span class="pre">FilterBufferProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2178"><code class="docutils literal notranslate"><span class="pre">FilterDumpProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2181"><code class="docutils literal notranslate"><span class="pre">FilterMirrorProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2184"><code class="docutils literal notranslate"><span class="pre">FilterRedirectorProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2187"><code class="docutils literal notranslate"><span class="pre">FilterRewriterProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2190"><code class="docutils literal notranslate"><span class="pre">InputBarrierProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2193"><code class="docutils literal notranslate"><span class="pre">InputLinuxProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2196"><code class="docutils literal notranslate"><span class="pre">IothreadProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2200"><code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2203"><code class="docutils literal notranslate"><span class="pre">MemoryBackendFileProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2206"><code class="docutils literal notranslate"><span class="pre">MemoryBackendMemfdProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2209"><code class="docutils literal notranslate"><span class="pre">MemoryBackendEpcProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2212"><code class="docutils literal notranslate"><span class="pre">PrManagerHelperProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2215"><code class="docutils literal notranslate"><span class="pre">QtestProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2218"><code class="docutils literal notranslate"><span class="pre">RemoteObjectProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2222"><code class="docutils literal notranslate"><span class="pre">RngProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2225"><code class="docutils literal notranslate"><span class="pre">RngEgdProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2228"><code class="docutils literal notranslate"><span class="pre">RngRandomProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2231"><code class="docutils literal notranslate"><span class="pre">SevGuestProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2235"><code class="docutils literal notranslate"><span class="pre">ObjectType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2238"><code class="docutils literal notranslate"><span class="pre">ObjectOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2243"><code class="docutils literal notranslate"><span class="pre">object-add</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2248"><code class="docutils literal notranslate"><span class="pre">object-del</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2249">Device infrastructure (qdev)</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2254"><code class="docutils literal notranslate"><span class="pre">device-list-properties</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2261"><code class="docutils literal notranslate"><span class="pre">device_add</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2267"><code class="docutils literal notranslate"><span class="pre">device_del</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2271"><code class="docutils literal notranslate"><span class="pre">DEVICE_DELETED</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2275"><code class="docutils literal notranslate"><span class="pre">DEVICE_UNPLUG_GUEST_ERROR</span></code> (Event)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2276">Machines</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2280"><code class="docutils literal notranslate"><span class="pre">SysEmuTarget</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2283"><code class="docutils literal notranslate"><span class="pre">CpuS390State</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2286"><code class="docutils literal notranslate"><span class="pre">CpuInfoS390</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2289"><code class="docutils literal notranslate"><span class="pre">CpuInfoFast</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2293"><code class="docutils literal notranslate"><span class="pre">query-cpus-fast</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2296"><code class="docutils literal notranslate"><span class="pre">MachineInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2299"><code class="docutils literal notranslate"><span class="pre">query-machines</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2302"><code class="docutils literal notranslate"><span class="pre">CurrentMachineParams</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2305"><code class="docutils literal notranslate"><span class="pre">query-current-machine</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2308"><code class="docutils literal notranslate"><span class="pre">TargetInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2311"><code class="docutils literal notranslate"><span class="pre">query-target</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2315"><code class="docutils literal notranslate"><span class="pre">UuidInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2319"><code class="docutils literal notranslate"><span class="pre">query-uuid</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2322"><code class="docutils literal notranslate"><span class="pre">GuidInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2324"><code class="docutils literal notranslate"><span class="pre">query-vm-generation-id</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2327"><code class="docutils literal notranslate"><span class="pre">system_reset</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2331"><code class="docutils literal notranslate"><span class="pre">system_powerdown</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2336"><code class="docutils literal notranslate"><span class="pre">system_wakeup</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2339"><code class="docutils literal notranslate"><span class="pre">LostTickPolicy</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2344"><code class="docutils literal notranslate"><span class="pre">inject-nmi</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2347"><code class="docutils literal notranslate"><span class="pre">KvmInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2351"><code class="docutils literal notranslate"><span class="pre">query-kvm</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2354"><code class="docutils literal notranslate"><span class="pre">NumaOptionsType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2357"><code class="docutils literal notranslate"><span class="pre">NumaOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2360"><code class="docutils literal notranslate"><span class="pre">NumaNodeOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2363"><code class="docutils literal notranslate"><span class="pre">NumaDistOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2366"><code class="docutils literal notranslate"><span class="pre">X86CPURegister32</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2369"><code class="docutils literal notranslate"><span class="pre">X86CPUFeatureWordInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2372"><code class="docutils literal notranslate"><span class="pre">DummyForceArrays</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2375"><code class="docutils literal notranslate"><span class="pre">NumaCpuOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2378"><code class="docutils literal notranslate"><span class="pre">HmatLBMemoryHierarchy</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2381"><code class="docutils literal notranslate"><span class="pre">HmatLBDataType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2384"><code class="docutils literal notranslate"><span class="pre">NumaHmatLBOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2387"><code class="docutils literal notranslate"><span class="pre">HmatCacheAssociativity</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2390"><code class="docutils literal notranslate"><span class="pre">HmatCacheWritePolicy</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2393"><code class="docutils literal notranslate"><span class="pre">NumaHmatCacheOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2399"><code class="docutils literal notranslate"><span class="pre">memsave</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2405"><code class="docutils literal notranslate"><span class="pre">pmemsave</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2408"><code class="docutils literal notranslate"><span class="pre">Memdev</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2412"><code class="docutils literal notranslate"><span class="pre">query-memdev</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2416"><code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2419"><code class="docutils literal notranslate"><span class="pre">HotpluggableCPU</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2424"><code class="docutils literal notranslate"><span class="pre">query-hotpluggable-cpus</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2426"><code class="docutils literal notranslate"><span class="pre">set-numa-node</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2432"><code class="docutils literal notranslate"><span class="pre">balloon</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2435"><code class="docutils literal notranslate"><span class="pre">BalloonInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2439"><code class="docutils literal notranslate"><span class="pre">query-balloon</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2444"><code class="docutils literal notranslate"><span class="pre">BALLOON_CHANGE</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2447"><code class="docutils literal notranslate"><span class="pre">MemoryInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2450"><code class="docutils literal notranslate"><span class="pre">query-memory-size-summary</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2453"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2456"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2459"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2462"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2465"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfoKind</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2468"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfoWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2471"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfoWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2474"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfoWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2477"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfoWrapper</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2480"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2483"><code class="docutils literal notranslate"><span class="pre">SgxEPC</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2486"><code class="docutils literal notranslate"><span class="pre">SgxEPCProperties</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2489"><code class="docutils literal notranslate"><span class="pre">query-memory-devices</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2494"><code class="docutils literal notranslate"><span class="pre">MEMORY_DEVICE_SIZE_CHANGE</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2499"><code class="docutils literal notranslate"><span class="pre">MEM_UNPLUG_ERROR</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2502"><code class="docutils literal notranslate"><span class="pre">SMPConfiguration</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2506"><code class="docutils literal notranslate"><span class="pre">x-query-irq</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2511"><code class="docutils literal notranslate"><span class="pre">x-query-jit</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2515"><code class="docutils literal notranslate"><span class="pre">x-query-numa</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2520"><code class="docutils literal notranslate"><span class="pre">x-query-opcount</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2524"><code class="docutils literal notranslate"><span class="pre">x-query-profile</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2528"><code class="docutils literal notranslate"><span class="pre">x-query-ramblock</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2532"><code class="docutils literal notranslate"><span class="pre">x-query-rdma</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2536"><code class="docutils literal notranslate"><span class="pre">x-query-roms</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2540"><code class="docutils literal notranslate"><span class="pre">x-query-usb</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2543"><code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2547"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2550"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareResult</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2554"><code class="docutils literal notranslate"><span class="pre">CpuModelBaselineInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2559"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2565"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-comparison</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2571"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-baseline</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2575"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2580"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-expansion</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2585"><code class="docutils literal notranslate"><span class="pre">CpuDefinitionInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2589"><code class="docutils literal notranslate"><span class="pre">query-cpu-definitions</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2590">Record/replay</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2593"><code class="docutils literal notranslate"><span class="pre">ReplayMode</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2596"><code class="docutils literal notranslate"><span class="pre">ReplayInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2600"><code class="docutils literal notranslate"><span class="pre">query-replay</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2604"><code class="docutils literal notranslate"><span class="pre">replay-break</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2607"><code class="docutils literal notranslate"><span class="pre">replay-delete-break</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2611"><code class="docutils literal notranslate"><span class="pre">replay-seek</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2612">Yank feature</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2615"><code class="docutils literal notranslate"><span class="pre">YankInstanceType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2618"><code class="docutils literal notranslate"><span class="pre">YankInstanceBlockNode</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2621"><code class="docutils literal notranslate"><span class="pre">YankInstanceChardev</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2624"><code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2629"><code class="docutils literal notranslate"><span class="pre">yank</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2633"><code class="docutils literal notranslate"><span class="pre">query-yank</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2634">Miscellanea</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2639"><code class="docutils literal notranslate"><span class="pre">add_client</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2642"><code class="docutils literal notranslate"><span class="pre">NameInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2646"><code class="docutils literal notranslate"><span class="pre">query-name</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2649"><code class="docutils literal notranslate"><span class="pre">IOThreadInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2654"><code class="docutils literal notranslate"><span class="pre">query-iothreads</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2658"><code class="docutils literal notranslate"><span class="pre">stop</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2663"><code class="docutils literal notranslate"><span class="pre">cont</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2668"><code class="docutils literal notranslate"><span class="pre">x-exit-preconfig</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2675"><code class="docutils literal notranslate"><span class="pre">human-monitor-command</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2681"><code class="docutils literal notranslate"><span class="pre">getfd</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2686"><code class="docutils literal notranslate"><span class="pre">closefd</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2689"><code class="docutils literal notranslate"><span class="pre">AddfdInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2695"><code class="docutils literal notranslate"><span class="pre">add-fd</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2701"><code class="docutils literal notranslate"><span class="pre">remove-fd</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2704"><code class="docutils literal notranslate"><span class="pre">FdsetFdInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2707"><code class="docutils literal notranslate"><span class="pre">FdsetInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2712"><code class="docutils literal notranslate"><span class="pre">query-fdsets</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2715"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2718"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2721"><code class="docutils literal notranslate"><span class="pre">CommandLineOptionInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2726"><code class="docutils literal notranslate"><span class="pre">query-command-line-options</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2732"><code class="docutils literal notranslate"><span class="pre">RTC_CHANGE</span></code> (Event)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2736"><code class="docutils literal notranslate"><span class="pre">rtc-reset-reinjection</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2740"><code class="docutils literal notranslate"><span class="pre">SevState</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2744"><code class="docutils literal notranslate"><span class="pre">SevInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2749"><code class="docutils literal notranslate"><span class="pre">query-sev</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2753"><code class="docutils literal notranslate"><span class="pre">SevLaunchMeasureInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2758"><code class="docutils literal notranslate"><span class="pre">query-sev-launch-measure</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2762"><code class="docutils literal notranslate"><span class="pre">SevCapability</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2767"><code class="docutils literal notranslate"><span class="pre">query-sev-capabilities</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2771"><code class="docutils literal notranslate"><span class="pre">sev-inject-launch-secret</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2775"><code class="docutils literal notranslate"><span class="pre">SevAttestationReport</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2781"><code class="docutils literal notranslate"><span class="pre">query-sev-attestation-report</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2787"><code class="docutils literal notranslate"><span class="pre">dump-skeys</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2791"><code class="docutils literal notranslate"><span class="pre">GICCapability</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2796"><code class="docutils literal notranslate"><span class="pre">query-gic-capabilities</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2799"><code class="docutils literal notranslate"><span class="pre">SGXEPCSection</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2804"><code class="docutils literal notranslate"><span class="pre">SGXInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2809"><code class="docutils literal notranslate"><span class="pre">query-sgx</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2814"><code class="docutils literal notranslate"><span class="pre">query-sgx-capabilities</span></code> (Command)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2815">Audio</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2818"><code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2821"><code class="docutils literal notranslate"><span class="pre">AudiodevGenericOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2824"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2827"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2830"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2833"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2836"><code class="docutils literal notranslate"><span class="pre">AudiodevDsoundOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2839"><code class="docutils literal notranslate"><span class="pre">AudiodevJackPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2842"><code class="docutils literal notranslate"><span class="pre">AudiodevJackOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2845"><code class="docutils literal notranslate"><span class="pre">AudiodevOssPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2848"><code class="docutils literal notranslate"><span class="pre">AudiodevOssOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2851"><code class="docutils literal notranslate"><span class="pre">AudiodevPaPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2854"><code class="docutils literal notranslate"><span class="pre">AudiodevPaOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2857"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlPerDirectionOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2860"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2863"><code class="docutils literal notranslate"><span class="pre">AudiodevWavOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2866"><code class="docutils literal notranslate"><span class="pre">AudioFormat</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2869"><code class="docutils literal notranslate"><span class="pre">AudiodevDriver</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2872"><code class="docutils literal notranslate"><span class="pre">Audiodev</span></code> (Object)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2873">ACPI</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2876"><code class="docutils literal notranslate"><span class="pre">AcpiTableOptions</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2878"><code class="docutils literal notranslate"><span class="pre">ACPISlotType</span></code> (Enum)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2881"><code class="docutils literal notranslate"><span class="pre">ACPIOSTInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2884"><code class="docutils literal notranslate"><span class="pre">query-acpi-ospm-status</span></code> (Command)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2888"><code class="docutils literal notranslate"><span class="pre">ACPI_DEVICE_OST</span></code> (Event)</a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#qapidoc-2889">PCI</a><ul> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2892"><code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2895"><code class="docutils literal notranslate"><span class="pre">PciMemoryRegion</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2898"><code class="docutils literal notranslate"><span class="pre">PciBusInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2901"><code class="docutils literal notranslate"><span class="pre">PciBridgeInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2904"><code class="docutils literal notranslate"><span class="pre">PciDeviceClass</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2907"><code class="docutils literal notranslate"><span class="pre">PciDeviceId</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2911"><code class="docutils literal notranslate"><span class="pre">PciDeviceInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2914"><code class="docutils literal notranslate"><span class="pre">PciInfo</span></code> (Object)</a></li> <li class="toctree-l4"><a class="reference internal" href="#qapidoc-2919"><code class="docutils literal notranslate"><span class="pre">query-pci</span></code> (Command)</a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="qemu-storage-daemon-qmp-ref.html">QEMU Storage Daemon QMP Reference Manual</a></li> <li class="toctree-l2"><a class="reference internal" href="vhost-user.html">Vhost-user Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="vhost-user-gpu.html">Vhost-user-gpu Protocol</a></li> <li class="toctree-l2"><a class="reference internal" href="vhost-vdpa.html">Vhost-vdpa Protocol</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../specs/index.html">System Emulation Guest Hardware Specifications</a></li> <li class="toctree-l1"><a class="reference internal" href="../devel/index.html">Developer Information</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../index.html">QEMU</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="../index.html">Docs</a> »</li> <li><a href="index.html">System Emulation Management and Interoperability</a> »</li> <li>QEMU QMP Reference Manual</li> <li class="wy-breadcrumbs-aside"> <a href="https://gitlab.com/qemu-project/qemu/blob/master/docs/interop/qemu-qmp-ref.rst" class="fa fa-gitlab"> Edit on GitLab</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="qemu-qmp-reference-manual"> <h1><a class="toc-backref" href="#id1">QEMU QMP Reference Manual</a><a class="headerlink" href="#qemu-qmp-reference-manual" title="Permalink to this headline">¶</a></h1> <div class="contents topic" id="contents"> <p class="topic-title first">Contents</p> <ul class="simple"> <li><a class="reference internal" href="#qemu-qmp-reference-manual" id="id1">QEMU QMP Reference Manual</a><ul> <li><a class="reference internal" href="#qapidoc-0" id="id2">Introduction</a><ul> <li><a class="reference internal" href="#qapidoc-1" id="id3">This document describes all commands currently supported by QMP.</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2" id="id4">Stability Considerations</a><ul> <li><a class="reference internal" href="#qapidoc-3" id="id5">The current QMP command set (described in this file) may be useful for a number of use cases, however it’s limited and several commands have bad defined semantics, specially with regard to command completion.</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-4" id="id6">QMP errors</a><ul> <li><a class="reference internal" href="#qapidoc-7" id="id7"><code class="docutils literal notranslate"><span class="pre">QapiErrorClass</span></code> (Enum)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-8" id="id8">Common data types</a><ul> <li><a class="reference internal" href="#qapidoc-11" id="id9"><code class="docutils literal notranslate"><span class="pre">IoOperationType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-14" id="id10"><code class="docutils literal notranslate"><span class="pre">OnOffAuto</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-17" id="id11"><code class="docutils literal notranslate"><span class="pre">OnOffSplit</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-20" id="id12"><code class="docutils literal notranslate"><span class="pre">String</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-23" id="id13"><code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (Alternate)</a></li> <li><a class="reference internal" href="#qapidoc-26" id="id14"><code class="docutils literal notranslate"><span class="pre">OffAutoPCIBAR</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-29" id="id15"><code class="docutils literal notranslate"><span class="pre">PCIELinkSpeed</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-32" id="id16"><code class="docutils literal notranslate"><span class="pre">PCIELinkWidth</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-35" id="id17"><code class="docutils literal notranslate"><span class="pre">HostMemPolicy</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-38" id="id18"><code class="docutils literal notranslate"><span class="pre">NetFilterDirection</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-41" id="id19"><code class="docutils literal notranslate"><span class="pre">GrabToggleKeys</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-44" id="id20"><code class="docutils literal notranslate"><span class="pre">HumanReadableText</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-45" id="id21">Socket data types</a><ul> <li><a class="reference internal" href="#qapidoc-48" id="id22"><code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-50" id="id23"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressBase</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-53" id="id24"><code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-56" id="id25"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddress</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-60" id="id26"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddress</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-63" id="id27"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-66" id="id28"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddressWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-69" id="id29"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddressWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-72" id="id30"><code class="docutils literal notranslate"><span class="pre">StringWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-76" id="id31"><code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-79" id="id32"><code class="docutils literal notranslate"><span class="pre">SocketAddressType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-82" id="id33"><code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-83" id="id34">VM run state</a><ul> <li><a class="reference internal" href="#qapidoc-85" id="id35"><code class="docutils literal notranslate"><span class="pre">RunState</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-87" id="id36"><code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-91" id="id37"><code class="docutils literal notranslate"><span class="pre">StatusInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-95" id="id38"><code class="docutils literal notranslate"><span class="pre">query-status</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-100" id="id39"><code class="docutils literal notranslate"><span class="pre">SHUTDOWN</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-103" id="id40"><code class="docutils literal notranslate"><span class="pre">POWERDOWN</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-107" id="id41"><code class="docutils literal notranslate"><span class="pre">RESET</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-110" id="id42"><code class="docutils literal notranslate"><span class="pre">STOP</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-113" id="id43"><code class="docutils literal notranslate"><span class="pre">RESUME</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-116" id="id44"><code class="docutils literal notranslate"><span class="pre">SUSPEND</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-120" id="id45"><code class="docutils literal notranslate"><span class="pre">SUSPEND_DISK</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-123" id="id46"><code class="docutils literal notranslate"><span class="pre">WAKEUP</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-129" id="id47"><code class="docutils literal notranslate"><span class="pre">WATCHDOG</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-132" id="id48"><code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-135" id="id49"><code class="docutils literal notranslate"><span class="pre">RebootAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-138" id="id50"><code class="docutils literal notranslate"><span class="pre">ShutdownAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-141" id="id51"><code class="docutils literal notranslate"><span class="pre">PanicAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-144" id="id52"><code class="docutils literal notranslate"><span class="pre">watchdog-set-action</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-149" id="id53"><code class="docutils literal notranslate"><span class="pre">set-action</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-153" id="id54"><code class="docutils literal notranslate"><span class="pre">GUEST_PANICKED</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-157" id="id55"><code class="docutils literal notranslate"><span class="pre">GUEST_CRASHLOADED</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-160" id="id56"><code class="docutils literal notranslate"><span class="pre">GuestPanicAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-163" id="id57"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-166" id="id58"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformation</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-169" id="id59"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationHyperV</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-172" id="id60"><code class="docutils literal notranslate"><span class="pre">S390CrashReason</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-175" id="id61"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationS390</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-179" id="id62"><code class="docutils literal notranslate"><span class="pre">MEMORY_FAILURE</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-182" id="id63"><code class="docutils literal notranslate"><span class="pre">MemoryFailureRecipient</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-185" id="id64"><code class="docutils literal notranslate"><span class="pre">MemoryFailureAction</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-188" id="id65"><code class="docutils literal notranslate"><span class="pre">MemoryFailureFlags</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-189" id="id66">Cryptography</a><ul> <li><a class="reference internal" href="#qapidoc-192" id="id67"><code class="docutils literal notranslate"><span class="pre">QCryptoTLSCredsEndpoint</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-195" id="id68"><code class="docutils literal notranslate"><span class="pre">QCryptoSecretFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-198" id="id69"><code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-201" id="id70"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-204" id="id71"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-207" id="id72"><code class="docutils literal notranslate"><span class="pre">QCryptoIVGenAlgorithm</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-210" id="id73"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-213" id="id74"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-216" id="id75"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-219" id="id76"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-222" id="id77"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptionsLUKS</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-225" id="id78"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOpenOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-228" id="id79"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-231" id="id80"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoBase</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-234" id="id81"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKSSlot</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-237" id="id82"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-240" id="id83"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-243" id="id84"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockLUKSKeyslotState</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-246" id="id85"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptionsLUKS</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-249" id="id86"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-253" id="id87"><code class="docutils literal notranslate"><span class="pre">SecretCommonProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-256" id="id88"><code class="docutils literal notranslate"><span class="pre">SecretProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-259" id="id89"><code class="docutils literal notranslate"><span class="pre">SecretKeyringProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-262" id="id90"><code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-266" id="id91"><code class="docutils literal notranslate"><span class="pre">TlsCredsAnonProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-270" id="id92"><code class="docutils literal notranslate"><span class="pre">TlsCredsPskProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-274" id="id93"><code class="docutils literal notranslate"><span class="pre">TlsCredsX509Properties</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-275" id="id94">Block devices</a><ul> <li><a class="reference internal" href="#qapidoc-276" id="id95">Block core (VM unrelated)</a></li> <li><a class="reference internal" href="#qapidoc-277" id="id96">Background jobs</a></li> <li><a class="reference internal" href="#qapidoc-998" id="id97">Additional block stuff (VM related)</a></li> <li><a class="reference internal" href="#qapidoc-1065" id="id98">Block device exports</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1130" id="id99">Character devices</a><ul> <li><a class="reference internal" href="#qapidoc-1134" id="id100"><code class="docutils literal notranslate"><span class="pre">ChardevInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1138" id="id101"><code class="docutils literal notranslate"><span class="pre">query-chardev</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1141" id="id102"><code class="docutils literal notranslate"><span class="pre">ChardevBackendInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1145" id="id103"><code class="docutils literal notranslate"><span class="pre">query-chardev-backends</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1148" id="id104"><code class="docutils literal notranslate"><span class="pre">DataFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1153" id="id105"><code class="docutils literal notranslate"><span class="pre">ringbuf-write</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1158" id="id106"><code class="docutils literal notranslate"><span class="pre">ringbuf-read</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1161" id="id107"><code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1164" id="id108"><code class="docutils literal notranslate"><span class="pre">ChardevFile</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1167" id="id109"><code class="docutils literal notranslate"><span class="pre">ChardevHostdev</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1170" id="id110"><code class="docutils literal notranslate"><span class="pre">ChardevSocket</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1173" id="id111"><code class="docutils literal notranslate"><span class="pre">ChardevUdp</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1176" id="id112"><code class="docutils literal notranslate"><span class="pre">ChardevMux</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1179" id="id113"><code class="docutils literal notranslate"><span class="pre">ChardevStdio</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1183" id="id114"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannel</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1187" id="id115"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePort</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1190" id="id116"><code class="docutils literal notranslate"><span class="pre">ChardevVC</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1193" id="id117"><code class="docutils literal notranslate"><span class="pre">ChardevRingbuf</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1197" id="id118"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgent</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1200" id="id119"><code class="docutils literal notranslate"><span class="pre">ChardevBackendKind</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1203" id="id120"><code class="docutils literal notranslate"><span class="pre">ChardevFileWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1206" id="id121"><code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1209" id="id122"><code class="docutils literal notranslate"><span class="pre">ChardevSocketWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1212" id="id123"><code class="docutils literal notranslate"><span class="pre">ChardevUdpWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1215" id="id124"><code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1218" id="id125"><code class="docutils literal notranslate"><span class="pre">ChardevMuxWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1221" id="id126"><code class="docutils literal notranslate"><span class="pre">ChardevStdioWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1225" id="id127"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannelWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1229" id="id128"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePortWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1233" id="id129"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgentWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1236" id="id130"><code class="docutils literal notranslate"><span class="pre">ChardevVCWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1239" id="id131"><code class="docutils literal notranslate"><span class="pre">ChardevRingbufWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1242" id="id132"><code class="docutils literal notranslate"><span class="pre">ChardevBackend</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1245" id="id133"><code class="docutils literal notranslate"><span class="pre">ChardevReturn</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1250" id="id134"><code class="docutils literal notranslate"><span class="pre">chardev-add</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1255" id="id135"><code class="docutils literal notranslate"><span class="pre">chardev-change</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1260" id="id136"><code class="docutils literal notranslate"><span class="pre">chardev-remove</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1265" id="id137"><code class="docutils literal notranslate"><span class="pre">chardev-send-break</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1270" id="id138"><code class="docutils literal notranslate"><span class="pre">VSERPORT_CHANGE</span></code> (Event)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1271" id="id139">Dump guest memory</a><ul> <li><a class="reference internal" href="#qapidoc-1274" id="id140"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1280" id="id141"><code class="docutils literal notranslate"><span class="pre">dump-guest-memory</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1283" id="id142"><code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1286" id="id143"><code class="docutils literal notranslate"><span class="pre">DumpQueryResult</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1290" id="id144"><code class="docutils literal notranslate"><span class="pre">query-dump</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1294" id="id145"><code class="docutils literal notranslate"><span class="pre">DUMP_COMPLETED</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1297" id="id146"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryCapability</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1301" id="id147"><code class="docutils literal notranslate"><span class="pre">query-dump-guest-memory-capability</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1302" id="id148">Net devices</a><ul> <li><a class="reference internal" href="#qapidoc-1308" id="id149"><code class="docutils literal notranslate"><span class="pre">set_link</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1313" id="id150"><code class="docutils literal notranslate"><span class="pre">netdev_add</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1318" id="id151"><code class="docutils literal notranslate"><span class="pre">netdev_del</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1321" id="id152"><code class="docutils literal notranslate"><span class="pre">NetLegacyNicOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1324" id="id153"><code class="docutils literal notranslate"><span class="pre">NetdevUserOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1327" id="id154"><code class="docutils literal notranslate"><span class="pre">NetdevTapOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1330" id="id155"><code class="docutils literal notranslate"><span class="pre">NetdevSocketOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1333" id="id156"><code class="docutils literal notranslate"><span class="pre">NetdevL2TPv3Options</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1336" id="id157"><code class="docutils literal notranslate"><span class="pre">NetdevVdeOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1339" id="id158"><code class="docutils literal notranslate"><span class="pre">NetdevBridgeOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1342" id="id159"><code class="docutils literal notranslate"><span class="pre">NetdevHubPortOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1345" id="id160"><code class="docutils literal notranslate"><span class="pre">NetdevNetmapOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1348" id="id161"><code class="docutils literal notranslate"><span class="pre">NetdevVhostUserOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1351" id="id162"><code class="docutils literal notranslate"><span class="pre">NetdevVhostVDPAOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1354" id="id163"><code class="docutils literal notranslate"><span class="pre">NetClientDriver</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1357" id="id164"><code class="docutils literal notranslate"><span class="pre">Netdev</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1360" id="id165"><code class="docutils literal notranslate"><span class="pre">RxState</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1363" id="id166"><code class="docutils literal notranslate"><span class="pre">RxFilterInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1368" id="id167"><code class="docutils literal notranslate"><span class="pre">query-rx-filter</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1372" id="id168"><code class="docutils literal notranslate"><span class="pre">NIC_RX_FILTER_CHANGED</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1375" id="id169"><code class="docutils literal notranslate"><span class="pre">AnnounceParameters</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1379" id="id170"><code class="docutils literal notranslate"><span class="pre">announce-self</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1383" id="id171"><code class="docutils literal notranslate"><span class="pre">FAILOVER_NEGOTIATED</span></code> (Event)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1384" id="id172">RDMA device</a><ul> <li><a class="reference internal" href="#qapidoc-1389" id="id173"><code class="docutils literal notranslate"><span class="pre">RDMA_GID_STATUS_CHANGED</span></code> (Event)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1390" id="id174">Rocker switch device</a><ul> <li><a class="reference internal" href="#qapidoc-1393" id="id175"><code class="docutils literal notranslate"><span class="pre">RockerSwitch</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1398" id="id176"><code class="docutils literal notranslate"><span class="pre">query-rocker</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1401" id="id177"><code class="docutils literal notranslate"><span class="pre">RockerPortDuplex</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1404" id="id178"><code class="docutils literal notranslate"><span class="pre">RockerPortAutoneg</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1407" id="id179"><code class="docutils literal notranslate"><span class="pre">RockerPort</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1412" id="id180"><code class="docutils literal notranslate"><span class="pre">query-rocker-ports</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1416" id="id181"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowKey</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1420" id="id182"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowMask</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1424" id="id183"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowAction</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1427" id="id184"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlow</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1432" id="id185"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-flows</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1436" id="id186"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaGroup</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1441" id="id187"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-groups</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1442" id="id188">TPM (trusted platform module) devices</a><ul> <li><a class="reference internal" href="#qapidoc-1446" id="id189"><code class="docutils literal notranslate"><span class="pre">TpmModel</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1451" id="id190"><code class="docutils literal notranslate"><span class="pre">query-tpm-models</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1455" id="id191"><code class="docutils literal notranslate"><span class="pre">TpmType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1460" id="id192"><code class="docutils literal notranslate"><span class="pre">query-tpm-types</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1464" id="id193"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1468" id="id194"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1472" id="id195"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptionsWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1476" id="id196"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptionsWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1480" id="id197"><code class="docutils literal notranslate"><span class="pre">TpmTypeOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1484" id="id198"><code class="docutils literal notranslate"><span class="pre">TPMInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1489" id="id199"><code class="docutils literal notranslate"><span class="pre">query-tpm</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1490" id="id200">Remote desktop</a><ul> <li><a class="reference internal" href="#qapidoc-1495" id="id201"><code class="docutils literal notranslate"><span class="pre">set_password</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1501" id="id202"><code class="docutils literal notranslate"><span class="pre">expire_password</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1506" id="id203"><code class="docutils literal notranslate"><span class="pre">screendump</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1507" id="id204">Spice</a></li> <li><a class="reference internal" href="#qapidoc-1553" id="id205">VNC</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1616" id="id206">Input</a><ul> <li><a class="reference internal" href="#qapidoc-1619" id="id207"><code class="docutils literal notranslate"><span class="pre">MouseInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1623" id="id208"><code class="docutils literal notranslate"><span class="pre">query-mice</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1627" id="id209"><code class="docutils literal notranslate"><span class="pre">QKeyCode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1630" id="id210"><code class="docutils literal notranslate"><span class="pre">KeyValueKind</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1633" id="id211"><code class="docutils literal notranslate"><span class="pre">IntWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1636" id="id212"><code class="docutils literal notranslate"><span class="pre">QKeyCodeWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1639" id="id213"><code class="docutils literal notranslate"><span class="pre">KeyValue</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1644" id="id214"><code class="docutils literal notranslate"><span class="pre">send-key</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1647" id="id215"><code class="docutils literal notranslate"><span class="pre">InputButton</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1650" id="id216"><code class="docutils literal notranslate"><span class="pre">InputAxis</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1653" id="id217"><code class="docutils literal notranslate"><span class="pre">InputKeyEvent</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1656" id="id218"><code class="docutils literal notranslate"><span class="pre">InputBtnEvent</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1659" id="id219"><code class="docutils literal notranslate"><span class="pre">InputMoveEvent</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1662" id="id220"><code class="docutils literal notranslate"><span class="pre">InputEventKind</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1665" id="id221"><code class="docutils literal notranslate"><span class="pre">InputKeyEventWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1668" id="id222"><code class="docutils literal notranslate"><span class="pre">InputBtnEventWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1671" id="id223"><code class="docutils literal notranslate"><span class="pre">InputMoveEventWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1674" id="id224"><code class="docutils literal notranslate"><span class="pre">InputEvent</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1680" id="id225"><code class="docutils literal notranslate"><span class="pre">input-send-event</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1683" id="id226"><code class="docutils literal notranslate"><span class="pre">DisplayGTK</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1686" id="id227"><code class="docutils literal notranslate"><span class="pre">DisplayEGLHeadless</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1689" id="id228"><code class="docutils literal notranslate"><span class="pre">DisplayGLMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1692" id="id229"><code class="docutils literal notranslate"><span class="pre">DisplayCurses</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1695" id="id230"><code class="docutils literal notranslate"><span class="pre">DisplayType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1698" id="id231"><code class="docutils literal notranslate"><span class="pre">DisplayOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1701" id="id232"><code class="docutils literal notranslate"><span class="pre">query-display-options</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1704" id="id233"><code class="docutils literal notranslate"><span class="pre">DisplayReloadType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1707" id="id234"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptionsVNC</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1710" id="id235"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1715" id="id236"><code class="docutils literal notranslate"><span class="pre">display-reload</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1716" id="id237">User authorization</a><ul> <li><a class="reference internal" href="#qapidoc-1719" id="id238"><code class="docutils literal notranslate"><span class="pre">QAuthZListPolicy</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1722" id="id239"><code class="docutils literal notranslate"><span class="pre">QAuthZListFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1725" id="id240"><code class="docutils literal notranslate"><span class="pre">QAuthZListRule</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1728" id="id241"><code class="docutils literal notranslate"><span class="pre">AuthZListProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1731" id="id242"><code class="docutils literal notranslate"><span class="pre">AuthZListFileProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1734" id="id243"><code class="docutils literal notranslate"><span class="pre">AuthZPAMProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1737" id="id244"><code class="docutils literal notranslate"><span class="pre">AuthZSimpleProperties</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1738" id="id245">Migration</a><ul> <li><a class="reference internal" href="#qapidoc-1741" id="id246"><code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1744" id="id247"><code class="docutils literal notranslate"><span class="pre">XBZRLECacheStats</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1747" id="id248"><code class="docutils literal notranslate"><span class="pre">CompressionStats</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1750" id="id249"><code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1753" id="id250"><code class="docutils literal notranslate"><span class="pre">VfioStats</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1756" id="id251"><code class="docutils literal notranslate"><span class="pre">MigrationInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1760" id="id252"><code class="docutils literal notranslate"><span class="pre">query-migrate</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1764" id="id253"><code class="docutils literal notranslate"><span class="pre">MigrationCapability</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1767" id="id254"><code class="docutils literal notranslate"><span class="pre">MigrationCapabilityStatus</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1771" id="id255"><code class="docutils literal notranslate"><span class="pre">migrate-set-capabilities</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1775" id="id256"><code class="docutils literal notranslate"><span class="pre">query-migrate-capabilities</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1778" id="id257"><code class="docutils literal notranslate"><span class="pre">MultiFDCompression</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1781" id="id258"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAliasTransform</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1784" id="id259"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAlias</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1787" id="id260"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationNodeAlias</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1791" id="id261"><code class="docutils literal notranslate"><span class="pre">MigrationParameter</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1795" id="id262"><code class="docutils literal notranslate"><span class="pre">MigrateSetParameters</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1799" id="id263"><code class="docutils literal notranslate"><span class="pre">migrate-set-parameters</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1803" id="id264"><code class="docutils literal notranslate"><span class="pre">MigrationParameters</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1807" id="id265"><code class="docutils literal notranslate"><span class="pre">query-migrate-parameters</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1811" id="id266"><code class="docutils literal notranslate"><span class="pre">client_migrate_info</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1814" id="id267"><code class="docutils literal notranslate"><span class="pre">migrate-start-postcopy</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1818" id="id268"><code class="docutils literal notranslate"><span class="pre">MIGRATION</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1822" id="id269"><code class="docutils literal notranslate"><span class="pre">MIGRATION_PASS</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1825" id="id270"><code class="docutils literal notranslate"><span class="pre">COLOMessage</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1828" id="id271"><code class="docutils literal notranslate"><span class="pre">COLOMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1831" id="id272"><code class="docutils literal notranslate"><span class="pre">FailoverStatus</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1835" id="id273"><code class="docutils literal notranslate"><span class="pre">COLO_EXIT</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1838" id="id274"><code class="docutils literal notranslate"><span class="pre">COLOExitReason</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1842" id="id275"><code class="docutils literal notranslate"><span class="pre">x-colo-lost-heartbeat</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1847" id="id276"><code class="docutils literal notranslate"><span class="pre">migrate_cancel</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1852" id="id277"><code class="docutils literal notranslate"><span class="pre">migrate-continue</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1858" id="id278"><code class="docutils literal notranslate"><span class="pre">migrate</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1864" id="id279"><code class="docutils literal notranslate"><span class="pre">migrate-incoming</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1869" id="id280"><code class="docutils literal notranslate"><span class="pre">xen-save-devices-state</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1874" id="id281"><code class="docutils literal notranslate"><span class="pre">xen-set-global-dirty-log</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1878" id="id282"><code class="docutils literal notranslate"><span class="pre">xen-load-devices-state</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1884" id="id283"><code class="docutils literal notranslate"><span class="pre">xen-set-replication</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1888" id="id284"><code class="docutils literal notranslate"><span class="pre">ReplicationStatus</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1893" id="id285"><code class="docutils literal notranslate"><span class="pre">query-xen-replication-status</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1898" id="id286"><code class="docutils literal notranslate"><span class="pre">xen-colo-do-checkpoint</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1901" id="id287"><code class="docutils literal notranslate"><span class="pre">COLOStatus</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1905" id="id288"><code class="docutils literal notranslate"><span class="pre">query-colo-status</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1910" id="id289"><code class="docutils literal notranslate"><span class="pre">migrate-recover</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1914" id="id290"><code class="docutils literal notranslate"><span class="pre">migrate-pause</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1918" id="id291"><code class="docutils literal notranslate"><span class="pre">UNPLUG_PRIMARY</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-1921" id="id292"><code class="docutils literal notranslate"><span class="pre">DirtyRateVcpu</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1924" id="id293"><code class="docutils literal notranslate"><span class="pre">DirtyRateStatus</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1927" id="id294"><code class="docutils literal notranslate"><span class="pre">DirtyRateMeasureMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1930" id="id295"><code class="docutils literal notranslate"><span class="pre">DirtyRateInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1934" id="id296"><code class="docutils literal notranslate"><span class="pre">calc-dirty-rate</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1936" id="id297"><code class="docutils literal notranslate"><span class="pre">query-dirty-rate</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1942" id="id298"><code class="docutils literal notranslate"><span class="pre">snapshot-save</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1948" id="id299"><code class="docutils literal notranslate"><span class="pre">snapshot-load</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-1954" id="id300"><code class="docutils literal notranslate"><span class="pre">snapshot-delete</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-1955" id="id301">Transactions</a><ul> <li><a class="reference internal" href="#qapidoc-1957" id="id302"><code class="docutils literal notranslate"><span class="pre">Abort</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1960" id="id303"><code class="docutils literal notranslate"><span class="pre">ActionCompletionMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1964" id="id304"><code class="docutils literal notranslate"><span class="pre">TransactionActionKind</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-1967" id="id305"><code class="docutils literal notranslate"><span class="pre">AbortWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1970" id="id306"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAddWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1973" id="id307"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1976" id="id308"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMergeWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1979" id="id309"><code class="docutils literal notranslate"><span class="pre">BlockdevBackupWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1982" id="id310"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1985" id="id311"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternalWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1988" id="id312"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSyncWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1991" id="id313"><code class="docutils literal notranslate"><span class="pre">DriveBackupWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1994" id="id314"><code class="docutils literal notranslate"><span class="pre">TransactionAction</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-1997" id="id315"><code class="docutils literal notranslate"><span class="pre">TransactionProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2003" id="id316"><code class="docutils literal notranslate"><span class="pre">transaction</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2004" id="id317">Tracing</a><ul> <li><a class="reference internal" href="#qapidoc-2007" id="id318"><code class="docutils literal notranslate"><span class="pre">TraceEventState</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2011" id="id319"><code class="docutils literal notranslate"><span class="pre">TraceEventInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2016" id="id320"><code class="docutils literal notranslate"><span class="pre">trace-event-get-state</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2021" id="id321"><code class="docutils literal notranslate"><span class="pre">trace-event-set-state</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2022" id="id322">Compatibility policy</a><ul> <li><a class="reference internal" href="#qapidoc-2025" id="id323"><code class="docutils literal notranslate"><span class="pre">CompatPolicyInput</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2028" id="id324"><code class="docutils literal notranslate"><span class="pre">CompatPolicyOutput</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2031" id="id325"><code class="docutils literal notranslate"><span class="pre">CompatPolicy</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2032" id="id326">QMP monitor control</a><ul> <li><a class="reference internal" href="#qapidoc-2037" id="id327"><code class="docutils literal notranslate"><span class="pre">qmp_capabilities</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2040" id="id328"><code class="docutils literal notranslate"><span class="pre">QMPCapability</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2043" id="id329"><code class="docutils literal notranslate"><span class="pre">VersionTriple</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2046" id="id330"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2050" id="id331"><code class="docutils literal notranslate"><span class="pre">query-version</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2053" id="id332"><code class="docutils literal notranslate"><span class="pre">CommandInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2058" id="id333"><code class="docutils literal notranslate"><span class="pre">query-commands</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2061" id="id334"><code class="docutils literal notranslate"><span class="pre">quit</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2064" id="id335"><code class="docutils literal notranslate"><span class="pre">MonitorMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2067" id="id336"><code class="docutils literal notranslate"><span class="pre">MonitorOptions</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2068" id="id337">QMP introspection</a><ul> <li><a class="reference internal" href="#qapidoc-2072" id="id338"><code class="docutils literal notranslate"><span class="pre">query-qmp-schema</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2075" id="id339"><code class="docutils literal notranslate"><span class="pre">SchemaMetaType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2079" id="id340"><code class="docutils literal notranslate"><span class="pre">SchemaInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2082" id="id341"><code class="docutils literal notranslate"><span class="pre">SchemaInfoBuiltin</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2085" id="id342"><code class="docutils literal notranslate"><span class="pre">JSONType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2090" id="id343"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnum</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2093" id="id344"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnumMember</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2097" id="id345"><code class="docutils literal notranslate"><span class="pre">SchemaInfoArray</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2101" id="id346"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObject</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2104" id="id347"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectMember</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2107" id="id348"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectVariant</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2111" id="id349"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternate</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2114" id="id350"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternateMember</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2118" id="id351"><code class="docutils literal notranslate"><span class="pre">SchemaInfoCommand</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2121" id="id352"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEvent</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2122" id="id353">QEMU Object Model (QOM)</a><ul> <li><a class="reference internal" href="#qapidoc-2125" id="id354"><code class="docutils literal notranslate"><span class="pre">ObjectPropertyInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2130" id="id355"><code class="docutils literal notranslate"><span class="pre">qom-list</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2135" id="id356"><code class="docutils literal notranslate"><span class="pre">qom-get</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2139" id="id357"><code class="docutils literal notranslate"><span class="pre">qom-set</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2142" id="id358"><code class="docutils literal notranslate"><span class="pre">ObjectTypeInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2146" id="id359"><code class="docutils literal notranslate"><span class="pre">qom-list-types</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2151" id="id360"><code class="docutils literal notranslate"><span class="pre">qom-list-properties</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2154" id="id361"><code class="docutils literal notranslate"><span class="pre">CanHostSocketcanProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2157" id="id362"><code class="docutils literal notranslate"><span class="pre">ColoCompareProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2160" id="id363"><code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2163" id="id364"><code class="docutils literal notranslate"><span class="pre">CryptodevVhostUserProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2166" id="id365"><code class="docutils literal notranslate"><span class="pre">DBusVMStateProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2169" id="id366"><code class="docutils literal notranslate"><span class="pre">NetfilterInsert</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2172" id="id367"><code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2175" id="id368"><code class="docutils literal notranslate"><span class="pre">FilterBufferProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2178" id="id369"><code class="docutils literal notranslate"><span class="pre">FilterDumpProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2181" id="id370"><code class="docutils literal notranslate"><span class="pre">FilterMirrorProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2184" id="id371"><code class="docutils literal notranslate"><span class="pre">FilterRedirectorProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2187" id="id372"><code class="docutils literal notranslate"><span class="pre">FilterRewriterProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2190" id="id373"><code class="docutils literal notranslate"><span class="pre">InputBarrierProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2193" id="id374"><code class="docutils literal notranslate"><span class="pre">InputLinuxProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2196" id="id375"><code class="docutils literal notranslate"><span class="pre">IothreadProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2200" id="id376"><code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2203" id="id377"><code class="docutils literal notranslate"><span class="pre">MemoryBackendFileProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2206" id="id378"><code class="docutils literal notranslate"><span class="pre">MemoryBackendMemfdProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2209" id="id379"><code class="docutils literal notranslate"><span class="pre">MemoryBackendEpcProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2212" id="id380"><code class="docutils literal notranslate"><span class="pre">PrManagerHelperProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2215" id="id381"><code class="docutils literal notranslate"><span class="pre">QtestProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2218" id="id382"><code class="docutils literal notranslate"><span class="pre">RemoteObjectProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2222" id="id383"><code class="docutils literal notranslate"><span class="pre">RngProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2225" id="id384"><code class="docutils literal notranslate"><span class="pre">RngEgdProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2228" id="id385"><code class="docutils literal notranslate"><span class="pre">RngRandomProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2231" id="id386"><code class="docutils literal notranslate"><span class="pre">SevGuestProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2235" id="id387"><code class="docutils literal notranslate"><span class="pre">ObjectType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2238" id="id388"><code class="docutils literal notranslate"><span class="pre">ObjectOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2243" id="id389"><code class="docutils literal notranslate"><span class="pre">object-add</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2248" id="id390"><code class="docutils literal notranslate"><span class="pre">object-del</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2249" id="id391">Device infrastructure (qdev)</a><ul> <li><a class="reference internal" href="#qapidoc-2254" id="id392"><code class="docutils literal notranslate"><span class="pre">device-list-properties</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2261" id="id393"><code class="docutils literal notranslate"><span class="pre">device_add</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2267" id="id394"><code class="docutils literal notranslate"><span class="pre">device_del</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2271" id="id395"><code class="docutils literal notranslate"><span class="pre">DEVICE_DELETED</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-2275" id="id396"><code class="docutils literal notranslate"><span class="pre">DEVICE_UNPLUG_GUEST_ERROR</span></code> (Event)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2276" id="id397">Machines</a><ul> <li><a class="reference internal" href="#qapidoc-2280" id="id398"><code class="docutils literal notranslate"><span class="pre">SysEmuTarget</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2283" id="id399"><code class="docutils literal notranslate"><span class="pre">CpuS390State</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2286" id="id400"><code class="docutils literal notranslate"><span class="pre">CpuInfoS390</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2289" id="id401"><code class="docutils literal notranslate"><span class="pre">CpuInfoFast</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2293" id="id402"><code class="docutils literal notranslate"><span class="pre">query-cpus-fast</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2296" id="id403"><code class="docutils literal notranslate"><span class="pre">MachineInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2299" id="id404"><code class="docutils literal notranslate"><span class="pre">query-machines</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2302" id="id405"><code class="docutils literal notranslate"><span class="pre">CurrentMachineParams</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2305" id="id406"><code class="docutils literal notranslate"><span class="pre">query-current-machine</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2308" id="id407"><code class="docutils literal notranslate"><span class="pre">TargetInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2311" id="id408"><code class="docutils literal notranslate"><span class="pre">query-target</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2315" id="id409"><code class="docutils literal notranslate"><span class="pre">UuidInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2319" id="id410"><code class="docutils literal notranslate"><span class="pre">query-uuid</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2322" id="id411"><code class="docutils literal notranslate"><span class="pre">GuidInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2324" id="id412"><code class="docutils literal notranslate"><span class="pre">query-vm-generation-id</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2327" id="id413"><code class="docutils literal notranslate"><span class="pre">system_reset</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2331" id="id414"><code class="docutils literal notranslate"><span class="pre">system_powerdown</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2336" id="id415"><code class="docutils literal notranslate"><span class="pre">system_wakeup</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2339" id="id416"><code class="docutils literal notranslate"><span class="pre">LostTickPolicy</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2344" id="id417"><code class="docutils literal notranslate"><span class="pre">inject-nmi</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2347" id="id418"><code class="docutils literal notranslate"><span class="pre">KvmInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2351" id="id419"><code class="docutils literal notranslate"><span class="pre">query-kvm</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2354" id="id420"><code class="docutils literal notranslate"><span class="pre">NumaOptionsType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2357" id="id421"><code class="docutils literal notranslate"><span class="pre">NumaOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2360" id="id422"><code class="docutils literal notranslate"><span class="pre">NumaNodeOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2363" id="id423"><code class="docutils literal notranslate"><span class="pre">NumaDistOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2366" id="id424"><code class="docutils literal notranslate"><span class="pre">X86CPURegister32</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2369" id="id425"><code class="docutils literal notranslate"><span class="pre">X86CPUFeatureWordInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2372" id="id426"><code class="docutils literal notranslate"><span class="pre">DummyForceArrays</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2375" id="id427"><code class="docutils literal notranslate"><span class="pre">NumaCpuOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2378" id="id428"><code class="docutils literal notranslate"><span class="pre">HmatLBMemoryHierarchy</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2381" id="id429"><code class="docutils literal notranslate"><span class="pre">HmatLBDataType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2384" id="id430"><code class="docutils literal notranslate"><span class="pre">NumaHmatLBOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2387" id="id431"><code class="docutils literal notranslate"><span class="pre">HmatCacheAssociativity</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2390" id="id432"><code class="docutils literal notranslate"><span class="pre">HmatCacheWritePolicy</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2393" id="id433"><code class="docutils literal notranslate"><span class="pre">NumaHmatCacheOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2399" id="id434"><code class="docutils literal notranslate"><span class="pre">memsave</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2405" id="id435"><code class="docutils literal notranslate"><span class="pre">pmemsave</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2408" id="id436"><code class="docutils literal notranslate"><span class="pre">Memdev</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2412" id="id437"><code class="docutils literal notranslate"><span class="pre">query-memdev</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2416" id="id438"><code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2419" id="id439"><code class="docutils literal notranslate"><span class="pre">HotpluggableCPU</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2424" id="id440"><code class="docutils literal notranslate"><span class="pre">query-hotpluggable-cpus</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2426" id="id441"><code class="docutils literal notranslate"><span class="pre">set-numa-node</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2432" id="id442"><code class="docutils literal notranslate"><span class="pre">balloon</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2435" id="id443"><code class="docutils literal notranslate"><span class="pre">BalloonInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2439" id="id444"><code class="docutils literal notranslate"><span class="pre">query-balloon</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2444" id="id445"><code class="docutils literal notranslate"><span class="pre">BALLOON_CHANGE</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-2447" id="id446"><code class="docutils literal notranslate"><span class="pre">MemoryInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2450" id="id447"><code class="docutils literal notranslate"><span class="pre">query-memory-size-summary</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2453" id="id448"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2456" id="id449"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2459" id="id450"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2462" id="id451"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2465" id="id452"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfoKind</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2468" id="id453"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfoWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2471" id="id454"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfoWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2474" id="id455"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfoWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2477" id="id456"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfoWrapper</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2480" id="id457"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2483" id="id458"><code class="docutils literal notranslate"><span class="pre">SgxEPC</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2486" id="id459"><code class="docutils literal notranslate"><span class="pre">SgxEPCProperties</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2489" id="id460"><code class="docutils literal notranslate"><span class="pre">query-memory-devices</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2494" id="id461"><code class="docutils literal notranslate"><span class="pre">MEMORY_DEVICE_SIZE_CHANGE</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-2499" id="id462"><code class="docutils literal notranslate"><span class="pre">MEM_UNPLUG_ERROR</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-2502" id="id463"><code class="docutils literal notranslate"><span class="pre">SMPConfiguration</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2506" id="id464"><code class="docutils literal notranslate"><span class="pre">x-query-irq</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2511" id="id465"><code class="docutils literal notranslate"><span class="pre">x-query-jit</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2515" id="id466"><code class="docutils literal notranslate"><span class="pre">x-query-numa</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2520" id="id467"><code class="docutils literal notranslate"><span class="pre">x-query-opcount</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2524" id="id468"><code class="docutils literal notranslate"><span class="pre">x-query-profile</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2528" id="id469"><code class="docutils literal notranslate"><span class="pre">x-query-ramblock</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2532" id="id470"><code class="docutils literal notranslate"><span class="pre">x-query-rdma</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2536" id="id471"><code class="docutils literal notranslate"><span class="pre">x-query-roms</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2540" id="id472"><code class="docutils literal notranslate"><span class="pre">x-query-usb</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2543" id="id473"><code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2547" id="id474"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2550" id="id475"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareResult</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2554" id="id476"><code class="docutils literal notranslate"><span class="pre">CpuModelBaselineInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2559" id="id477"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2565" id="id478"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-comparison</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2571" id="id479"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-baseline</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2575" id="id480"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2580" id="id481"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-expansion</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2585" id="id482"><code class="docutils literal notranslate"><span class="pre">CpuDefinitionInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2589" id="id483"><code class="docutils literal notranslate"><span class="pre">query-cpu-definitions</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2590" id="id484">Record/replay</a><ul> <li><a class="reference internal" href="#qapidoc-2593" id="id485"><code class="docutils literal notranslate"><span class="pre">ReplayMode</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2596" id="id486"><code class="docutils literal notranslate"><span class="pre">ReplayInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2600" id="id487"><code class="docutils literal notranslate"><span class="pre">query-replay</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2604" id="id488"><code class="docutils literal notranslate"><span class="pre">replay-break</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2607" id="id489"><code class="docutils literal notranslate"><span class="pre">replay-delete-break</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2611" id="id490"><code class="docutils literal notranslate"><span class="pre">replay-seek</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2612" id="id491">Yank feature</a><ul> <li><a class="reference internal" href="#qapidoc-2615" id="id492"><code class="docutils literal notranslate"><span class="pre">YankInstanceType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2618" id="id493"><code class="docutils literal notranslate"><span class="pre">YankInstanceBlockNode</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2621" id="id494"><code class="docutils literal notranslate"><span class="pre">YankInstanceChardev</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2624" id="id495"><code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2629" id="id496"><code class="docutils literal notranslate"><span class="pre">yank</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2633" id="id497"><code class="docutils literal notranslate"><span class="pre">query-yank</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2634" id="id498">Miscellanea</a><ul> <li><a class="reference internal" href="#qapidoc-2639" id="id499"><code class="docutils literal notranslate"><span class="pre">add_client</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2642" id="id500"><code class="docutils literal notranslate"><span class="pre">NameInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2646" id="id501"><code class="docutils literal notranslate"><span class="pre">query-name</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2649" id="id502"><code class="docutils literal notranslate"><span class="pre">IOThreadInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2654" id="id503"><code class="docutils literal notranslate"><span class="pre">query-iothreads</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2658" id="id504"><code class="docutils literal notranslate"><span class="pre">stop</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2663" id="id505"><code class="docutils literal notranslate"><span class="pre">cont</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2668" id="id506"><code class="docutils literal notranslate"><span class="pre">x-exit-preconfig</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2675" id="id507"><code class="docutils literal notranslate"><span class="pre">human-monitor-command</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2681" id="id508"><code class="docutils literal notranslate"><span class="pre">getfd</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2686" id="id509"><code class="docutils literal notranslate"><span class="pre">closefd</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2689" id="id510"><code class="docutils literal notranslate"><span class="pre">AddfdInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2695" id="id511"><code class="docutils literal notranslate"><span class="pre">add-fd</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2701" id="id512"><code class="docutils literal notranslate"><span class="pre">remove-fd</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2704" id="id513"><code class="docutils literal notranslate"><span class="pre">FdsetFdInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2707" id="id514"><code class="docutils literal notranslate"><span class="pre">FdsetInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2712" id="id515"><code class="docutils literal notranslate"><span class="pre">query-fdsets</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2715" id="id516"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2718" id="id517"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2721" id="id518"><code class="docutils literal notranslate"><span class="pre">CommandLineOptionInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2726" id="id519"><code class="docutils literal notranslate"><span class="pre">query-command-line-options</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2732" id="id520"><code class="docutils literal notranslate"><span class="pre">RTC_CHANGE</span></code> (Event)</a></li> <li><a class="reference internal" href="#qapidoc-2736" id="id521"><code class="docutils literal notranslate"><span class="pre">rtc-reset-reinjection</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2740" id="id522"><code class="docutils literal notranslate"><span class="pre">SevState</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2744" id="id523"><code class="docutils literal notranslate"><span class="pre">SevInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2749" id="id524"><code class="docutils literal notranslate"><span class="pre">query-sev</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2753" id="id525"><code class="docutils literal notranslate"><span class="pre">SevLaunchMeasureInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2758" id="id526"><code class="docutils literal notranslate"><span class="pre">query-sev-launch-measure</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2762" id="id527"><code class="docutils literal notranslate"><span class="pre">SevCapability</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2767" id="id528"><code class="docutils literal notranslate"><span class="pre">query-sev-capabilities</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2771" id="id529"><code class="docutils literal notranslate"><span class="pre">sev-inject-launch-secret</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2775" id="id530"><code class="docutils literal notranslate"><span class="pre">SevAttestationReport</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2781" id="id531"><code class="docutils literal notranslate"><span class="pre">query-sev-attestation-report</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2787" id="id532"><code class="docutils literal notranslate"><span class="pre">dump-skeys</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2791" id="id533"><code class="docutils literal notranslate"><span class="pre">GICCapability</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2796" id="id534"><code class="docutils literal notranslate"><span class="pre">query-gic-capabilities</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2799" id="id535"><code class="docutils literal notranslate"><span class="pre">SGXEPCSection</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2804" id="id536"><code class="docutils literal notranslate"><span class="pre">SGXInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2809" id="id537"><code class="docutils literal notranslate"><span class="pre">query-sgx</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2814" id="id538"><code class="docutils literal notranslate"><span class="pre">query-sgx-capabilities</span></code> (Command)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2815" id="id539">Audio</a><ul> <li><a class="reference internal" href="#qapidoc-2818" id="id540"><code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2821" id="id541"><code class="docutils literal notranslate"><span class="pre">AudiodevGenericOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2824" id="id542"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2827" id="id543"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2830" id="id544"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2833" id="id545"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2836" id="id546"><code class="docutils literal notranslate"><span class="pre">AudiodevDsoundOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2839" id="id547"><code class="docutils literal notranslate"><span class="pre">AudiodevJackPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2842" id="id548"><code class="docutils literal notranslate"><span class="pre">AudiodevJackOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2845" id="id549"><code class="docutils literal notranslate"><span class="pre">AudiodevOssPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2848" id="id550"><code class="docutils literal notranslate"><span class="pre">AudiodevOssOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2851" id="id551"><code class="docutils literal notranslate"><span class="pre">AudiodevPaPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2854" id="id552"><code class="docutils literal notranslate"><span class="pre">AudiodevPaOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2857" id="id553"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlPerDirectionOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2860" id="id554"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2863" id="id555"><code class="docutils literal notranslate"><span class="pre">AudiodevWavOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2866" id="id556"><code class="docutils literal notranslate"><span class="pre">AudioFormat</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2869" id="id557"><code class="docutils literal notranslate"><span class="pre">AudiodevDriver</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2872" id="id558"><code class="docutils literal notranslate"><span class="pre">Audiodev</span></code> (Object)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2873" id="id559">ACPI</a><ul> <li><a class="reference internal" href="#qapidoc-2876" id="id560"><code class="docutils literal notranslate"><span class="pre">AcpiTableOptions</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2878" id="id561"><code class="docutils literal notranslate"><span class="pre">ACPISlotType</span></code> (Enum)</a></li> <li><a class="reference internal" href="#qapidoc-2881" id="id562"><code class="docutils literal notranslate"><span class="pre">ACPIOSTInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2884" id="id563"><code class="docutils literal notranslate"><span class="pre">query-acpi-ospm-status</span></code> (Command)</a></li> <li><a class="reference internal" href="#qapidoc-2888" id="id564"><code class="docutils literal notranslate"><span class="pre">ACPI_DEVICE_OST</span></code> (Event)</a></li> </ul> </li> <li><a class="reference internal" href="#qapidoc-2889" id="id565">PCI</a><ul> <li><a class="reference internal" href="#qapidoc-2892" id="id566"><code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2895" id="id567"><code class="docutils literal notranslate"><span class="pre">PciMemoryRegion</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2898" id="id568"><code class="docutils literal notranslate"><span class="pre">PciBusInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2901" id="id569"><code class="docutils literal notranslate"><span class="pre">PciBridgeInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2904" id="id570"><code class="docutils literal notranslate"><span class="pre">PciDeviceClass</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2907" id="id571"><code class="docutils literal notranslate"><span class="pre">PciDeviceId</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2911" id="id572"><code class="docutils literal notranslate"><span class="pre">PciDeviceInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2914" id="id573"><code class="docutils literal notranslate"><span class="pre">PciInfo</span></code> (Object)</a></li> <li><a class="reference internal" href="#qapidoc-2919" id="id574"><code class="docutils literal notranslate"><span class="pre">query-pci</span></code> (Command)</a></li> </ul> </li> </ul> </li> </ul> </div> <div class="section" id="qapidoc-0"> <h2><a class="toc-backref" href="#id2">Introduction</a><a class="headerlink" href="#qapidoc-0" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1"> <p>This document describes all commands currently supported by QMP.</p> <p>Most of the time their usage is exactly the same as in the user Monitor, this means that any other document which also describe commands (the manpage, QEMU’s manual, etc) can and should be consulted.</p> <p>QMP has two types of commands: regular and query commands. Regular commands usually change the Virtual Machine’s state someway, while query commands just return information. The sections below are divided accordingly.</p> <p>It’s important to observe that all communication examples are formatted in a reader-friendly way, so that they’re easier to understand. However, in real protocol usage, they’re emitted as a single line.</p> <p>Also, the following notation is used to denote data flow:</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="n">data</span> <span class="n">issued</span> <span class="n">by</span> <span class="n">the</span> <span class="n">Client</span> <span class="o"><-</span> <span class="n">Server</span> <span class="n">data</span> <span class="n">response</span> </pre></div> </div> <p>Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for detailed information on the Server command and response formats.</p> </div> </div> <div class="section" id="qapidoc-2"> <h2><a class="toc-backref" href="#id4">Stability Considerations</a><a class="headerlink" href="#qapidoc-2" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-3"> <p>The current QMP command set (described in this file) may be useful for a number of use cases, however it’s limited and several commands have bad defined semantics, specially with regard to command completion.</p> <p>These problems are going to be solved incrementally in the next QEMU releases and we’re going to establish a deprecation policy for badly defined commands.</p> <p>If you’re planning to adopt QMP, please observe the following:</p> <blockquote> <div><ol class="arabic simple"> <li>The deprecation policy will take effect and be documented soon, please check the documentation of each used command as soon as a new release of QEMU is available</li> <li>DO NOT rely on anything which is not explicit documented</li> <li>Errors, in special, are not documented. Applications should NOT check for specific errors classes or data (it’s strongly recommended to only check for the “error” key)</li> </ol> </div></blockquote> </div> </div> <div class="section" id="qapidoc-4"> <h2><a class="toc-backref" href="#id6">QMP errors</a><a class="headerlink" href="#qapidoc-4" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-7"> <h3><a class="toc-backref" href="#id7"><code class="docutils literal notranslate"><span class="pre">QapiErrorClass</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-7" title="Permalink to this headline">¶</a></h3> <p>QEMU error classes</p> <div class="section" id="qapidoc-5"> <h4>Values<a class="headerlink" href="#qapidoc-5" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">GenericError</span></code></dt> <dd>this is used for errors that don’t require a specific error class. This should be the default case for most errors</dd> <dt><code class="docutils literal notranslate"><span class="pre">CommandNotFound</span></code></dt> <dd>the requested command has not been found</dd> <dt><code class="docutils literal notranslate"><span class="pre">DeviceNotActive</span></code></dt> <dd>a device has failed to be become active</dd> <dt><code class="docutils literal notranslate"><span class="pre">DeviceNotFound</span></code></dt> <dd>the requested device has not been found</dd> <dt><code class="docutils literal notranslate"><span class="pre">KVMMissingCap</span></code></dt> <dd>the requested operation can’t be fulfilled because a required KVM capability is missing</dd> </dl> </div> <div class="section" id="qapidoc-6"> <h4>Since<a class="headerlink" href="#qapidoc-6" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> </div> <div class="section" id="qapidoc-8"> <h2><a class="toc-backref" href="#id8">Common data types</a><a class="headerlink" href="#qapidoc-8" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-11"> <h3><a class="toc-backref" href="#id9"><code class="docutils literal notranslate"><span class="pre">IoOperationType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-11" title="Permalink to this headline">¶</a></h3> <p>An enumeration of the I/O operation types</p> <div class="section" id="qapidoc-9"> <h4>Values<a class="headerlink" href="#qapidoc-9" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">read</span></code></dt> <dd>read operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">write</span></code></dt> <dd>write operation</dd> </dl> </div> <div class="section" id="qapidoc-10"> <h4>Since<a class="headerlink" href="#qapidoc-10" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-14"> <h3><a class="toc-backref" href="#id10"><code class="docutils literal notranslate"><span class="pre">OnOffAuto</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-14" title="Permalink to this headline">¶</a></h3> <p>An enumeration of three options: on, off, and auto</p> <div class="section" id="qapidoc-12"> <h4>Values<a class="headerlink" href="#qapidoc-12" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>QEMU selects the value between on and off</dd> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>Enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>Disabled</dd> </dl> </div> <div class="section" id="qapidoc-13"> <h4>Since<a class="headerlink" href="#qapidoc-13" title="Permalink to this headline">¶</a></h4> <p>2.2</p> </div> </div> <div class="section" id="qapidoc-17"> <h3><a class="toc-backref" href="#id11"><code class="docutils literal notranslate"><span class="pre">OnOffSplit</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-17" title="Permalink to this headline">¶</a></h3> <p>An enumeration of three values: on, off, and split</p> <div class="section" id="qapidoc-15"> <h4>Values<a class="headerlink" href="#qapidoc-15" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>Enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>Disabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">split</span></code></dt> <dd>Mixed</dd> </dl> </div> <div class="section" id="qapidoc-16"> <h4>Since<a class="headerlink" href="#qapidoc-16" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-20"> <h3><a class="toc-backref" href="#id12"><code class="docutils literal notranslate"><span class="pre">String</span></code> (Object)</a><a class="headerlink" href="#qapidoc-20" title="Permalink to this headline">¶</a></h3> <p>A fat type wrapping ‘str’, to be embedded in lists.</p> <div class="section" id="qapidoc-18"> <h4>Members<a class="headerlink" href="#qapidoc-18" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">str</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-19"> <h4>Since<a class="headerlink" href="#qapidoc-19" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-23"> <h3><a class="toc-backref" href="#id13"><code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (Alternate)</a><a class="headerlink" href="#qapidoc-23" title="Permalink to this headline">¶</a></h3> <p>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.</p> <div class="section" id="qapidoc-21"> <h4>Members<a class="headerlink" href="#qapidoc-21" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">s</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the string value</dd> <dt><code class="docutils literal notranslate"><span class="pre">n</span></code>: <code class="docutils literal notranslate"><span class="pre">null</span></code></dt> <dd>no string value</dd> </dl> </div> <div class="section" id="qapidoc-22"> <h4>Since<a class="headerlink" href="#qapidoc-22" title="Permalink to this headline">¶</a></h4> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-26"> <h3><a class="toc-backref" href="#id14"><code class="docutils literal notranslate"><span class="pre">OffAutoPCIBAR</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-26" title="Permalink to this headline">¶</a></h3> <p>An enumeration of options for specifying a PCI BAR</p> <div class="section" id="qapidoc-24"> <h4>Values<a class="headerlink" href="#qapidoc-24" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>The specified feature is disabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>The PCI BAR for the feature is automatically selected</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar0</span></code></dt> <dd>PCI BAR0 is used for the feature</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar1</span></code></dt> <dd>PCI BAR1 is used for the feature</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar2</span></code></dt> <dd>PCI BAR2 is used for the feature</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar3</span></code></dt> <dd>PCI BAR3 is used for the feature</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar4</span></code></dt> <dd>PCI BAR4 is used for the feature</dd> <dt><code class="docutils literal notranslate"><span class="pre">bar5</span></code></dt> <dd>PCI BAR5 is used for the feature</dd> </dl> </div> <div class="section" id="qapidoc-25"> <h4>Since<a class="headerlink" href="#qapidoc-25" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-29"> <h3><a class="toc-backref" href="#id15"><code class="docutils literal notranslate"><span class="pre">PCIELinkSpeed</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-29" title="Permalink to this headline">¶</a></h3> <p>An enumeration of PCIe link speeds in units of GT/s</p> <div class="section" id="qapidoc-27"> <h4>Values<a class="headerlink" href="#qapidoc-27" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">2_5</span></code></dt> <dd>2.5GT/s</dd> <dt><code class="docutils literal notranslate"><span class="pre">5</span></code></dt> <dd>5.0GT/s</dd> <dt><code class="docutils literal notranslate"><span class="pre">8</span></code></dt> <dd>8.0GT/s</dd> <dt><code class="docutils literal notranslate"><span class="pre">16</span></code></dt> <dd>16.0GT/s</dd> </dl> </div> <div class="section" id="qapidoc-28"> <h4>Since<a class="headerlink" href="#qapidoc-28" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-32"> <h3><a class="toc-backref" href="#id16"><code class="docutils literal notranslate"><span class="pre">PCIELinkWidth</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-32" title="Permalink to this headline">¶</a></h3> <p>An enumeration of PCIe link width</p> <div class="section" id="qapidoc-30"> <h4>Values<a class="headerlink" href="#qapidoc-30" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">1</span></code></dt> <dd>x1</dd> <dt><code class="docutils literal notranslate"><span class="pre">2</span></code></dt> <dd>x2</dd> <dt><code class="docutils literal notranslate"><span class="pre">4</span></code></dt> <dd>x4</dd> <dt><code class="docutils literal notranslate"><span class="pre">8</span></code></dt> <dd>x8</dd> <dt><code class="docutils literal notranslate"><span class="pre">12</span></code></dt> <dd>x12</dd> <dt><code class="docutils literal notranslate"><span class="pre">16</span></code></dt> <dd>x16</dd> <dt><code class="docutils literal notranslate"><span class="pre">32</span></code></dt> <dd>x32</dd> </dl> </div> <div class="section" id="qapidoc-31"> <h4>Since<a class="headerlink" href="#qapidoc-31" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-35"> <h3><a class="toc-backref" href="#id17"><code class="docutils literal notranslate"><span class="pre">HostMemPolicy</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-35" title="Permalink to this headline">¶</a></h3> <p>Host memory policy types</p> <div class="section" id="qapidoc-33"> <h4>Values<a class="headerlink" href="#qapidoc-33" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">default</span></code></dt> <dd>restore default policy, remove any nondefault policy</dd> <dt><code class="docutils literal notranslate"><span class="pre">preferred</span></code></dt> <dd>set the preferred host nodes for allocation</dd> <dt><code class="docutils literal notranslate"><span class="pre">bind</span></code></dt> <dd>a strict policy that restricts memory allocation to the host nodes specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">interleave</span></code></dt> <dd>memory allocations are interleaved across the set of host nodes specified</dd> </dl> </div> <div class="section" id="qapidoc-34"> <h4>Since<a class="headerlink" href="#qapidoc-34" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-38"> <h3><a class="toc-backref" href="#id18"><code class="docutils literal notranslate"><span class="pre">NetFilterDirection</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-38" title="Permalink to this headline">¶</a></h3> <p>Indicates whether a netfilter is attached to a netdev’s transmit queue or receive queue or both.</p> <div class="section" id="qapidoc-36"> <h4>Values<a class="headerlink" href="#qapidoc-36" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">all</span></code></dt> <dd>the filter is attached both to the receive and the transmit queue of the netdev (default).</dd> <dt><code class="docutils literal notranslate"><span class="pre">rx</span></code></dt> <dd>the filter is attached to the receive queue of the netdev, where it will receive packets sent to the netdev.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tx</span></code></dt> <dd>the filter is attached to the transmit queue of the netdev, where it will receive packets sent by the netdev.</dd> </dl> </div> <div class="section" id="qapidoc-37"> <h4>Since<a class="headerlink" href="#qapidoc-37" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-41"> <h3><a class="toc-backref" href="#id19"><code class="docutils literal notranslate"><span class="pre">GrabToggleKeys</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-41" title="Permalink to this headline">¶</a></h3> <p>Keys to toggle input-linux between host and guest.</p> <div class="section" id="qapidoc-39"> <h4>Values<a class="headerlink" href="#qapidoc-39" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ctrl-ctrl</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">alt-alt</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">shift-shift</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">meta-meta</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">scrolllock</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ctrl-scrolllock</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-40"> <h4>Since<a class="headerlink" href="#qapidoc-40" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-44"> <h3><a class="toc-backref" href="#id20"><code class="docutils literal notranslate"><span class="pre">HumanReadableText</span></code> (Object)</a><a class="headerlink" href="#qapidoc-44" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-42"> <h4>Members<a class="headerlink" href="#qapidoc-42" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">human-readable-text</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Formatted output intended for humans.</dd> </dl> </div> <div class="section" id="qapidoc-43"> <h4>Since<a class="headerlink" href="#qapidoc-43" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> </div> <div class="section" id="qapidoc-45"> <h2><a class="toc-backref" href="#id21">Socket data types</a><a class="headerlink" href="#qapidoc-45" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-48"> <h3><a class="toc-backref" href="#id22"><code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-48" title="Permalink to this headline">¶</a></h3> <p>The network address family</p> <div class="section" id="qapidoc-46"> <h4>Values<a class="headerlink" href="#qapidoc-46" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ipv4</span></code></dt> <dd>IPV4 family</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6</span></code></dt> <dd>IPV6 family</dd> <dt><code class="docutils literal notranslate"><span class="pre">unix</span></code></dt> <dd>unix socket</dd> <dt><code class="docutils literal notranslate"><span class="pre">vsock</span></code></dt> <dd>vsock family (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unknown</span></code></dt> <dd>otherwise</dd> </dl> </div> <div class="section" id="qapidoc-47"> <h4>Since<a class="headerlink" href="#qapidoc-47" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-50"> <h3><a class="toc-backref" href="#id23"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressBase</span></code> (Object)</a><a class="headerlink" href="#qapidoc-50" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-49"> <h4>Members<a class="headerlink" href="#qapidoc-49" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>host part of the address</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>port part of the address</dd> </dl> </div> </div> <div class="section" id="qapidoc-53"> <h3><a class="toc-backref" href="#id24"><code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code> (Object)</a><a class="headerlink" href="#qapidoc-53" title="Permalink to this headline">¶</a></h3> <p>Captures a socket address or address range in the Internet namespace.</p> <div class="section" id="qapidoc-51"> <h4>Members<a class="headerlink" href="#qapidoc-51" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">numeric</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the host/port are guaranteed to be numeric, false if name resolution should be attempted. Defaults to false. (Since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">to</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>If present, this is range of possible addresses, with port between <code class="docutils literal notranslate"><span class="pre">port</span></code> and <code class="docutils literal notranslate"><span class="pre">to</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv4</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to accept IPv4 addresses, default try both IPv4 and IPv6</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to accept IPv6 addresses, default try both IPv4 and IPv6</dd> <dt><code class="docutils literal notranslate"><span class="pre">keep-alive</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable keep-alive when connecting to this socket. Not supported for passive sockets. (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mptcp</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional) (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_IPPROTO_MPTCP</span></code>)</dt> <dd>enable multi-path TCP. (Since 6.1)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">InetSocketAddressBase</span></code></dl> </div> <div class="section" id="qapidoc-52"> <h4>Since<a class="headerlink" href="#qapidoc-52" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-56"> <h3><a class="toc-backref" href="#id25"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddress</span></code> (Object)</a><a class="headerlink" href="#qapidoc-56" title="Permalink to this headline">¶</a></h3> <p>Captures a socket address in the local (“Unix socket”) namespace.</p> <div class="section" id="qapidoc-54"> <h4>Members<a class="headerlink" href="#qapidoc-54" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>filesystem path to use</dd> <dt><code class="docutils literal notranslate"><span class="pre">abstract</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional) (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>if true, this is a Linux abstract socket address. <code class="docutils literal notranslate"><span class="pre">path</span></code> will be prefixed by a null byte, and optionally padded with null bytes. Defaults to false. (Since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tight</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional) (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-55"> <h4>Since<a class="headerlink" href="#qapidoc-55" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-60"> <h3><a class="toc-backref" href="#id26"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddress</span></code> (Object)</a><a class="headerlink" href="#qapidoc-60" title="Permalink to this headline">¶</a></h3> <p>Captures a socket address in the vsock namespace.</p> <div class="section" id="qapidoc-57"> <h4>Members<a class="headerlink" href="#qapidoc-57" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>unique host identifier</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>port</dd> </dl> </div> <div class="section" id="qapidoc-58"> <h4>Note<a class="headerlink" href="#qapidoc-58" title="Permalink to this headline">¶</a></h4> <p>string types are used to allow for possible future hostname or service resolution support.</p> </div> <div class="section" id="qapidoc-59"> <h4>Since<a class="headerlink" href="#qapidoc-59" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-63"> <h3><a class="toc-backref" href="#id27"><code class="docutils literal notranslate"><span class="pre">InetSocketAddressWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-63" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-61"> <h4>Members<a class="headerlink" href="#qapidoc-61" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-62"> <h4>Since<a class="headerlink" href="#qapidoc-62" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-66"> <h3><a class="toc-backref" href="#id28"><code class="docutils literal notranslate"><span class="pre">UnixSocketAddressWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-66" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-64"> <h4>Members<a class="headerlink" href="#qapidoc-64" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">UnixSocketAddress</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-65"> <h4>Since<a class="headerlink" href="#qapidoc-65" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-69"> <h3><a class="toc-backref" href="#id29"><code class="docutils literal notranslate"><span class="pre">VsockSocketAddressWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-69" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-67"> <h4>Members<a class="headerlink" href="#qapidoc-67" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">VsockSocketAddress</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-68"> <h4>Since<a class="headerlink" href="#qapidoc-68" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-72"> <h3><a class="toc-backref" href="#id30"><code class="docutils literal notranslate"><span class="pre">StringWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-72" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-70"> <h4>Members<a class="headerlink" href="#qapidoc-70" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">String</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-71"> <h4>Since<a class="headerlink" href="#qapidoc-71" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-76"> <h3><a class="toc-backref" href="#id31"><code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code> (Object)</a><a class="headerlink" href="#qapidoc-76" title="Permalink to this headline">¶</a></h3> <p>Captures the address of a socket, which could also be a named file descriptor</p> <div class="section" id="qapidoc-73"> <h4>Members<a class="headerlink" href="#qapidoc-73" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressType</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">InetSocketAddressWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"inet"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">UnixSocketAddressWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"unix"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">VsockSocketAddressWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vsock"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">StringWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"fd"</span></code></dl> </div> <div class="section" id="qapidoc-74"> <h4>Note<a class="headerlink" href="#qapidoc-74" title="Permalink to this headline">¶</a></h4> <p>This type is deprecated in favor of SocketAddress. The difference between SocketAddressLegacy and SocketAddress is that the latter is has fewer {} on the wire.</p> </div> <div class="section" id="qapidoc-75"> <h4>Since<a class="headerlink" href="#qapidoc-75" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-79"> <h3><a class="toc-backref" href="#id32"><code class="docutils literal notranslate"><span class="pre">SocketAddressType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-79" title="Permalink to this headline">¶</a></h3> <p>Available SocketAddress types</p> <div class="section" id="qapidoc-77"> <h4>Values<a class="headerlink" href="#qapidoc-77" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">inet</span></code></dt> <dd>Internet address</dd> <dt><code class="docutils literal notranslate"><span class="pre">unix</span></code></dt> <dd>Unix domain socket</dd> <dt><code class="docutils literal notranslate"><span class="pre">vsock</span></code></dt> <dd>VMCI address</dd> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code></dt> <dd>decimal is for file descriptor number, otherwise a file descriptor name. Named file descriptors are permitted in monitor commands, in combination with the ‘getfd’ command. Decimal file descriptors are permitted at startup or other contexts where no monitor context is active.</dd> </dl> </div> <div class="section" id="qapidoc-78"> <h4>Since<a class="headerlink" href="#qapidoc-78" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-82"> <h3><a class="toc-backref" href="#id33"><code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code> (Object)</a><a class="headerlink" href="#qapidoc-82" title="Permalink to this headline">¶</a></h3> <p>Captures the address of a socket, which could also be a named file descriptor</p> <div class="section" id="qapidoc-80"> <h4>Members<a class="headerlink" href="#qapidoc-80" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressType</span></code></dt> <dd>Transport type</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"inet"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">UnixSocketAddress</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"unix"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">VsockSocketAddress</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vsock"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">String</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"fd"</span></code></dl> </div> <div class="section" id="qapidoc-81"> <h4>Since<a class="headerlink" href="#qapidoc-81" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> </div> <div class="section" id="qapidoc-83"> <h2><a class="toc-backref" href="#id34">VM run state</a><a class="headerlink" href="#qapidoc-83" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-85"> <h3><a class="toc-backref" href="#id35"><code class="docutils literal notranslate"><span class="pre">RunState</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-85" title="Permalink to this headline">¶</a></h3> <p>An enumeration of VM run states.</p> <div class="section" id="qapidoc-84"> <h4>Values<a class="headerlink" href="#qapidoc-84" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">debug</span></code></dt> <dd>QEMU is running on a debugger</dd> <dt><code class="docutils literal notranslate"><span class="pre">finish-migrate</span></code></dt> <dd>guest is paused to finish the migration process</dd> <dt><code class="docutils literal notranslate"><span class="pre">inmigrate</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">internal-error</span></code></dt> <dd>An internal error that prevents further guest execution has occurred</dd> <dt><code class="docutils literal notranslate"><span class="pre">io-error</span></code></dt> <dd>the last IOP has failed and the device is configured to pause on I/O errors</dd> <dt><code class="docutils literal notranslate"><span class="pre">paused</span></code></dt> <dd>guest has been paused via the ‘stop’ command</dd> <dt><code class="docutils literal notranslate"><span class="pre">postmigrate</span></code></dt> <dd>guest is paused following a successful ‘migrate’</dd> <dt><code class="docutils literal notranslate"><span class="pre">prelaunch</span></code></dt> <dd>QEMU was started with -S and guest has not started</dd> <dt><code class="docutils literal notranslate"><span class="pre">restore-vm</span></code></dt> <dd>guest is paused to restore VM state</dd> <dt><code class="docutils literal notranslate"><span class="pre">running</span></code></dt> <dd>guest is actively running</dd> <dt><code class="docutils literal notranslate"><span class="pre">save-vm</span></code></dt> <dd>guest is paused to save the VM state</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutdown</span></code></dt> <dd>guest is shut down (and -no-shutdown is in use)</dd> <dt><code class="docutils literal notranslate"><span class="pre">suspended</span></code></dt> <dd>guest is suspended (ACPI S3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">watchdog</span></code></dt> <dd>the watchdog action is configured to pause and has been triggered</dd> <dt><code class="docutils literal notranslate"><span class="pre">guest-panicked</span></code></dt> <dd>guest has been panicked as a result of guest OS panic</dd> <dt><code class="docutils literal notranslate"><span class="pre">colo</span></code></dt> <dd>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)</dd> </dl> </div> </div> <div class="section" id="qapidoc-87"> <h3><a class="toc-backref" href="#id36"><code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-87" title="Permalink to this headline">¶</a></h3> <p>An enumeration of reasons for a Shutdown.</p> <div class="section" id="qapidoc-86"> <h4>Values<a class="headerlink" href="#qapidoc-86" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>No shutdown request pending</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-error</span></code></dt> <dd>An error prevents further use of guest</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-qmp-quit</span></code></dt> <dd>Reaction to the QMP command ‘quit’</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-qmp-system-reset</span></code></dt> <dd>Reaction to the QMP command ‘system_reset’</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-signal</span></code></dt> <dd>Reaction to a signal, such as SIGINT</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-ui</span></code></dt> <dd>Reaction to a UI event, like window close</dd> <dt><code class="docutils literal notranslate"><span class="pre">guest-shutdown</span></code></dt> <dd>Guest shutdown/suspend request, via ACPI or other hardware-specific means</dd> <dt><code class="docutils literal notranslate"><span class="pre">guest-reset</span></code></dt> <dd>Guest reset request, and command line turns that into a shutdown</dd> <dt><code class="docutils literal notranslate"><span class="pre">guest-panic</span></code></dt> <dd>Guest panicked, and command line turns that into a shutdown</dd> <dt><code class="docutils literal notranslate"><span class="pre">subsystem-reset</span></code></dt> <dd>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</dd> </dl> </div> </div> <div class="section" id="qapidoc-91"> <h3><a class="toc-backref" href="#id37"><code class="docutils literal notranslate"><span class="pre">StatusInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-91" title="Permalink to this headline">¶</a></h3> <p>Information about VCPU run state</p> <div class="section" id="qapidoc-88"> <h4>Members<a class="headerlink" href="#qapidoc-88" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">running</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if all VCPUs are runnable, false if not runnable</dd> <dt><code class="docutils literal notranslate"><span class="pre">singlestep</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if VCPUs are in single-step mode</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">RunState</span></code></dt> <dd>the virtual machine <code class="docutils literal notranslate"><span class="pre">RunState</span></code></dd> </dl> </div> <div class="section" id="qapidoc-89"> <h4>Since<a class="headerlink" href="#qapidoc-89" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-90"> <h4>Notes<a class="headerlink" href="#qapidoc-90" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">singlestep</span></code> is enabled through the GDB stub</p> </div> </div> <div class="section" id="qapidoc-95"> <h3><a class="toc-backref" href="#id38"><code class="docutils literal notranslate"><span class="pre">query-status</span></code> (Command)</a><a class="headerlink" href="#qapidoc-95" title="Permalink to this headline">¶</a></h3> <p>Query the run status of all VCPUs</p> <div class="section" id="qapidoc-92"> <h4>Returns<a class="headerlink" href="#qapidoc-92" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">StatusInfo</span></code> reflecting all VCPUs</p> </div> <div class="section" id="qapidoc-93"> <h4>Since<a class="headerlink" href="#qapidoc-93" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-94"> <h4>Example<a class="headerlink" href="#qapidoc-94" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-status"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"running"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"singlestep"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"running"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-100"> <h3><a class="toc-backref" href="#id39"><code class="docutils literal notranslate"><span class="pre">SHUTDOWN</span></code> (Event)</a><a class="headerlink" href="#qapidoc-100" title="Permalink to this headline">¶</a></h3> <p>Emitted when the virtual machine has shut down, indicating that qemu is about to exit.</p> <div class="section" id="qapidoc-96"> <h4>Arguments<a class="headerlink" href="#qapidoc-96" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">guest</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code></dt> <dd>The <code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code> which resulted in the SHUTDOWN. (since 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-97"> <h4>Note<a class="headerlink" href="#qapidoc-97" title="Permalink to this headline">¶</a></h4> <p>If the command-line option “-no-shutdown” has been specified, qemu will not exit, and a STOP event will eventually follow the SHUTDOWN event</p> </div> <div class="section" id="qapidoc-98"> <h4>Since<a class="headerlink" href="#qapidoc-98" title="Permalink to this headline">¶</a></h4> <p>0.12</p> </div> <div class="section" id="qapidoc-99"> <h4>Example<a class="headerlink" href="#qapidoc-99" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SHUTDOWN"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"guest"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267040730</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">682951</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-103"> <h3><a class="toc-backref" href="#id40"><code class="docutils literal notranslate"><span class="pre">POWERDOWN</span></code> (Event)</a><a class="headerlink" href="#qapidoc-103" title="Permalink to this headline">¶</a></h3> <p>Emitted when the virtual machine is powered down through the power control system, such as via ACPI.</p> <div class="section" id="qapidoc-101"> <h4>Since<a class="headerlink" href="#qapidoc-101" title="Permalink to this headline">¶</a></h4> <p>0.12</p> </div> <div class="section" id="qapidoc-102"> <h4>Example<a class="headerlink" href="#qapidoc-102" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"POWERDOWN"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267040730</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">682951</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-107"> <h3><a class="toc-backref" href="#id41"><code class="docutils literal notranslate"><span class="pre">RESET</span></code> (Event)</a><a class="headerlink" href="#qapidoc-107" title="Permalink to this headline">¶</a></h3> <p>Emitted when the virtual machine is reset</p> <div class="section" id="qapidoc-104"> <h4>Arguments<a class="headerlink" href="#qapidoc-104" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">guest</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code></dt> <dd>The <code class="docutils literal notranslate"><span class="pre">ShutdownCause</span></code> of the RESET. (since 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-105"> <h4>Since<a class="headerlink" href="#qapidoc-105" title="Permalink to this headline">¶</a></h4> <p>0.12</p> </div> <div class="section" id="qapidoc-106"> <h4>Example<a class="headerlink" href="#qapidoc-106" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RESET"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"guest"</span><span class="p">:</span> <span class="n">false</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267041653</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">9518</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-110"> <h3><a class="toc-backref" href="#id42"><code class="docutils literal notranslate"><span class="pre">STOP</span></code> (Event)</a><a class="headerlink" href="#qapidoc-110" title="Permalink to this headline">¶</a></h3> <p>Emitted when the virtual machine is stopped</p> <div class="section" id="qapidoc-108"> <h4>Since<a class="headerlink" href="#qapidoc-108" title="Permalink to this headline">¶</a></h4> <p>0.12</p> </div> <div class="section" id="qapidoc-109"> <h4>Example<a class="headerlink" href="#qapidoc-109" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"STOP"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267041730</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">281295</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-113"> <h3><a class="toc-backref" href="#id43"><code class="docutils literal notranslate"><span class="pre">RESUME</span></code> (Event)</a><a class="headerlink" href="#qapidoc-113" title="Permalink to this headline">¶</a></h3> <p>Emitted when the virtual machine resumes execution</p> <div class="section" id="qapidoc-111"> <h4>Since<a class="headerlink" href="#qapidoc-111" title="Permalink to this headline">¶</a></h4> <p>0.12</p> </div> <div class="section" id="qapidoc-112"> <h4>Example<a class="headerlink" href="#qapidoc-112" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RESUME"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1271770767</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">582542</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-116"> <h3><a class="toc-backref" href="#id44"><code class="docutils literal notranslate"><span class="pre">SUSPEND</span></code> (Event)</a><a class="headerlink" href="#qapidoc-116" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest enters a hardware suspension state, for example, S3 state, which is sometimes called standby state</p> <div class="section" id="qapidoc-114"> <h4>Since<a class="headerlink" href="#qapidoc-114" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> <div class="section" id="qapidoc-115"> <h4>Example<a class="headerlink" href="#qapidoc-115" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SUSPEND"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1344456160</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">309119</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-120"> <h3><a class="toc-backref" href="#id45"><code class="docutils literal notranslate"><span class="pre">SUSPEND_DISK</span></code> (Event)</a><a class="headerlink" href="#qapidoc-120" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest enters a hardware suspension state with data saved on disk, for example, S4 state, which is sometimes called hibernate state</p> <div class="section" id="qapidoc-117"> <h4>Note<a class="headerlink" href="#qapidoc-117" title="Permalink to this headline">¶</a></h4> <p>QEMU shuts down (similar to event <code class="docutils literal notranslate"><span class="pre">SHUTDOWN</span></code>) when entering this state</p> </div> <div class="section" id="qapidoc-118"> <h4>Since<a class="headerlink" href="#qapidoc-118" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-119"> <h4>Example<a class="headerlink" href="#qapidoc-119" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SUSPEND_DISK"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1344456160</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">309119</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-123"> <h3><a class="toc-backref" href="#id46"><code class="docutils literal notranslate"><span class="pre">WAKEUP</span></code> (Event)</a><a class="headerlink" href="#qapidoc-123" title="Permalink to this headline">¶</a></h3> <p>Emitted when the guest has woken up from suspend state and is running</p> <div class="section" id="qapidoc-121"> <h4>Since<a class="headerlink" href="#qapidoc-121" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> <div class="section" id="qapidoc-122"> <h4>Example<a class="headerlink" href="#qapidoc-122" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"WAKEUP"</span><span class="p">,</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1344522075</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">745528</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-129"> <h3><a class="toc-backref" href="#id47"><code class="docutils literal notranslate"><span class="pre">WATCHDOG</span></code> (Event)</a><a class="headerlink" href="#qapidoc-129" title="Permalink to this headline">¶</a></h3> <p>Emitted when the watchdog device’s timer is expired</p> <div class="section" id="qapidoc-124"> <h4>Arguments<a class="headerlink" href="#qapidoc-124" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code></dt> <dd>action that has been taken</dd> </dl> </div> <div class="section" id="qapidoc-125"> <h4>Note<a class="headerlink" href="#qapidoc-125" title="Permalink to this headline">¶</a></h4> <p>If action is “reset”, “shutdown”, or “pause” the WATCHDOG event is followed respectively by the RESET, SHUTDOWN, or STOP events</p> </div> <div class="section" id="qapidoc-126"> <h4>Note<a class="headerlink" href="#qapidoc-126" title="Permalink to this headline">¶</a></h4> <p>This event is rate-limited.</p> </div> <div class="section" id="qapidoc-127"> <h4>Since<a class="headerlink" href="#qapidoc-127" title="Permalink to this headline">¶</a></h4> <p>0.13</p> </div> <div class="section" id="qapidoc-128"> <h4>Example<a class="headerlink" href="#qapidoc-128" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"WATCHDOG"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"reset"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267061043</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">959568</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-132"> <h3><a class="toc-backref" href="#id48"><code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-132" title="Permalink to this headline">¶</a></h3> <p>An enumeration of the actions taken when the watchdog device’s timer is expired</p> <div class="section" id="qapidoc-130"> <h4>Values<a class="headerlink" href="#qapidoc-130" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">reset</span></code></dt> <dd>system resets</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutdown</span></code></dt> <dd>system shutdown, note that it is similar to <code class="docutils literal notranslate"><span class="pre">powerdown</span></code>, which tries to set to system status and notify guest</dd> <dt><code class="docutils literal notranslate"><span class="pre">poweroff</span></code></dt> <dd>system poweroff, the emulator program exits</dd> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>system pauses, similar to <code class="docutils literal notranslate"><span class="pre">stop</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">debug</span></code></dt> <dd>system enters debug state</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>nothing is done</dd> <dt><code class="docutils literal notranslate"><span class="pre">inject-nmi</span></code></dt> <dd>a non-maskable interrupt is injected into the first VCPU (all VCPUS on x86) (since 2.4)</dd> </dl> </div> <div class="section" id="qapidoc-131"> <h4>Since<a class="headerlink" href="#qapidoc-131" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-135"> <h3><a class="toc-backref" href="#id49"><code class="docutils literal notranslate"><span class="pre">RebootAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-135" title="Permalink to this headline">¶</a></h3> <p>Possible QEMU actions upon guest reboot</p> <div class="section" id="qapidoc-133"> <h4>Values<a class="headerlink" href="#qapidoc-133" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">reset</span></code></dt> <dd>Reset the VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutdown</span></code></dt> <dd>Shutdown the VM and exit, according to the shutdown action</dd> </dl> </div> <div class="section" id="qapidoc-134"> <h4>Since<a class="headerlink" href="#qapidoc-134" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-138"> <h3><a class="toc-backref" href="#id50"><code class="docutils literal notranslate"><span class="pre">ShutdownAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-138" title="Permalink to this headline">¶</a></h3> <p>Possible QEMU actions upon guest shutdown</p> <div class="section" id="qapidoc-136"> <h4>Values<a class="headerlink" href="#qapidoc-136" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">poweroff</span></code></dt> <dd>Shutdown the VM and exit</dd> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>pause the VM#</dd> </dl> </div> <div class="section" id="qapidoc-137"> <h4>Since<a class="headerlink" href="#qapidoc-137" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-141"> <h3><a class="toc-backref" href="#id51"><code class="docutils literal notranslate"><span class="pre">PanicAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-141" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-139"> <h4>Values<a class="headerlink" href="#qapidoc-139" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Continue VM execution</dd> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>Pause the VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutdown</span></code></dt> <dd>Shutdown the VM and exit, according to the shutdown action</dd> </dl> </div> <div class="section" id="qapidoc-140"> <h4>Since<a class="headerlink" href="#qapidoc-140" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-144"> <h3><a class="toc-backref" href="#id52"><code class="docutils literal notranslate"><span class="pre">watchdog-set-action</span></code> (Command)</a><a class="headerlink" href="#qapidoc-144" title="Permalink to this headline">¶</a></h3> <p>Set watchdog action</p> <div class="section" id="qapidoc-142"> <h4>Arguments<a class="headerlink" href="#qapidoc-142" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-143"> <h4>Since<a class="headerlink" href="#qapidoc-143" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-149"> <h3><a class="toc-backref" href="#id53"><code class="docutils literal notranslate"><span class="pre">set-action</span></code> (Command)</a><a class="headerlink" href="#qapidoc-149" title="Permalink to this headline">¶</a></h3> <p>Set the actions that will be taken by the emulator in response to guest events.</p> <div class="section" id="qapidoc-145"> <h4>Arguments<a class="headerlink" href="#qapidoc-145" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">reboot</span></code>: <code class="docutils literal notranslate"><span class="pre">RebootAction</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">RebootAction</span></code> action taken on guest reboot.</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutdown</span></code>: <code class="docutils literal notranslate"><span class="pre">ShutdownAction</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">ShutdownAction</span></code> action taken on guest shutdown.</dd> <dt><code class="docutils literal notranslate"><span class="pre">panic</span></code>: <code class="docutils literal notranslate"><span class="pre">PanicAction</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">PanicAction</span></code> action taken on guest panic.</dd> <dt><code class="docutils literal notranslate"><span class="pre">watchdog</span></code>: <code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">WatchdogAction</span></code> action taken when watchdog timer expires .</dd> </dl> </div> <div class="section" id="qapidoc-146"> <h4>Returns<a class="headerlink" href="#qapidoc-146" title="Permalink to this headline">¶</a></h4> <p>Nothing on success.</p> </div> <div class="section" id="qapidoc-147"> <h4>Since<a class="headerlink" href="#qapidoc-147" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> <div class="section" id="qapidoc-148"> <h4>Example<a class="headerlink" href="#qapidoc-148" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"set-action"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"reboot"</span><span class="p">:</span> <span class="s2">"shutdown"</span><span class="p">,</span> <span class="s2">"shutdown"</span> <span class="p">:</span> <span class="s2">"pause"</span><span class="p">,</span> <span class="s2">"panic"</span><span class="p">:</span> <span class="s2">"pause"</span><span class="p">,</span> <span class="s2">"watchdog"</span><span class="p">:</span> <span class="s2">"inject-nmi"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-153"> <h3><a class="toc-backref" href="#id54"><code class="docutils literal notranslate"><span class="pre">GUEST_PANICKED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-153" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest OS panic is detected</p> <div class="section" id="qapidoc-150"> <h4>Arguments<a class="headerlink" href="#qapidoc-150" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">GuestPanicAction</span></code></dt> <dd>action that has been taken, currently always “pause”</dd> <dt><code class="docutils literal notranslate"><span class="pre">info</span></code>: <code class="docutils literal notranslate"><span class="pre">GuestPanicInformation</span></code> (optional)</dt> <dd>information about a panic (since 2.9)</dd> </dl> </div> <div class="section" id="qapidoc-151"> <h4>Since<a class="headerlink" href="#qapidoc-151" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-152"> <h4>Example<a class="headerlink" href="#qapidoc-152" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"GUEST_PANICKED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"pause"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-157"> <h3><a class="toc-backref" href="#id55"><code class="docutils literal notranslate"><span class="pre">GUEST_CRASHLOADED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-157" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest OS crash loaded is detected</p> <div class="section" id="qapidoc-154"> <h4>Arguments<a class="headerlink" href="#qapidoc-154" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">GuestPanicAction</span></code></dt> <dd>action that has been taken, currently always “run”</dd> <dt><code class="docutils literal notranslate"><span class="pre">info</span></code>: <code class="docutils literal notranslate"><span class="pre">GuestPanicInformation</span></code> (optional)</dt> <dd>information about a panic</dd> </dl> </div> <div class="section" id="qapidoc-155"> <h4>Since<a class="headerlink" href="#qapidoc-155" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> <div class="section" id="qapidoc-156"> <h4>Example<a class="headerlink" href="#qapidoc-156" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"GUEST_CRASHLOADED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"run"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-160"> <h3><a class="toc-backref" href="#id56"><code class="docutils literal notranslate"><span class="pre">GuestPanicAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-160" title="Permalink to this headline">¶</a></h3> <p>An enumeration of the actions taken when guest OS panic is detected</p> <div class="section" id="qapidoc-158"> <h4>Values<a class="headerlink" href="#qapidoc-158" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>system pauses</dd> <dt><code class="docutils literal notranslate"><span class="pre">poweroff</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">run</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-159"> <h4>Since<a class="headerlink" href="#qapidoc-159" title="Permalink to this headline">¶</a></h4> <p>2.1 (poweroff since 2.8, run since 5.0)</p> </div> </div> <div class="section" id="qapidoc-163"> <h3><a class="toc-backref" href="#id57"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-163" title="Permalink to this headline">¶</a></h3> <p>An enumeration of the guest panic information types</p> <div class="section" id="qapidoc-161"> <h4>Values<a class="headerlink" href="#qapidoc-161" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">hyper-v</span></code></dt> <dd>hyper-v guest panic information type</dd> <dt><code class="docutils literal notranslate"><span class="pre">s390</span></code></dt> <dd>s390 guest panic information type (Since: 2.12)</dd> </dl> </div> <div class="section" id="qapidoc-162"> <h4>Since<a class="headerlink" href="#qapidoc-162" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-166"> <h3><a class="toc-backref" href="#id58"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformation</span></code> (Object)</a><a class="headerlink" href="#qapidoc-166" title="Permalink to this headline">¶</a></h3> <p>Information about a guest panic</p> <div class="section" id="qapidoc-164"> <h4>Members<a class="headerlink" href="#qapidoc-164" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">GuestPanicInformationType</span></code></dt> <dd>Crash type that defines the hypervisor specific information</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">GuestPanicInformationHyperV</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"hyper-v"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">GuestPanicInformationS390</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"s390"</span></code></dl> </div> <div class="section" id="qapidoc-165"> <h4>Since<a class="headerlink" href="#qapidoc-165" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-169"> <h3><a class="toc-backref" href="#id59"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationHyperV</span></code> (Object)</a><a class="headerlink" href="#qapidoc-169" title="Permalink to this headline">¶</a></h3> <p>Hyper-V specific guest panic information (HV crash MSRs)</p> <div class="section" id="qapidoc-167"> <h4>Members<a class="headerlink" href="#qapidoc-167" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">arg1</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">arg2</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">arg3</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">arg4</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">arg5</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-168"> <h4>Since<a class="headerlink" href="#qapidoc-168" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-172"> <h3><a class="toc-backref" href="#id60"><code class="docutils literal notranslate"><span class="pre">S390CrashReason</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-172" title="Permalink to this headline">¶</a></h3> <p>Reason why the CPU is in a crashed state.</p> <div class="section" id="qapidoc-170"> <h4>Values<a class="headerlink" href="#qapidoc-170" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unknown</span></code></dt> <dd>no crash reason was set</dd> <dt><code class="docutils literal notranslate"><span class="pre">disabled-wait</span></code></dt> <dd>the CPU has entered a disabled wait state</dd> <dt><code class="docutils literal notranslate"><span class="pre">extint-loop</span></code></dt> <dd>clock comparator or cpu timer interrupt with new PSW enabled for external interrupts</dd> <dt><code class="docutils literal notranslate"><span class="pre">pgmint-loop</span></code></dt> <dd>program interrupt with BAD new PSW</dd> <dt><code class="docutils literal notranslate"><span class="pre">opint-loop</span></code></dt> <dd>operation exception interrupt with invalid code at the program interrupt new PSW</dd> </dl> </div> <div class="section" id="qapidoc-171"> <h4>Since<a class="headerlink" href="#qapidoc-171" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-175"> <h3><a class="toc-backref" href="#id61"><code class="docutils literal notranslate"><span class="pre">GuestPanicInformationS390</span></code> (Object)</a><a class="headerlink" href="#qapidoc-175" title="Permalink to this headline">¶</a></h3> <p>S390 specific guest panic information (PSW)</p> <div class="section" id="qapidoc-173"> <h4>Members<a class="headerlink" href="#qapidoc-173" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">core</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>core id of the CPU that crashed</dd> <dt><code class="docutils literal notranslate"><span class="pre">psw-mask</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>control fields of guest PSW</dd> <dt><code class="docutils literal notranslate"><span class="pre">psw-addr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>guest instruction address</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">S390CrashReason</span></code></dt> <dd>guest crash reason</dd> </dl> </div> <div class="section" id="qapidoc-174"> <h4>Since<a class="headerlink" href="#qapidoc-174" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-179"> <h3><a class="toc-backref" href="#id62"><code class="docutils literal notranslate"><span class="pre">MEMORY_FAILURE</span></code> (Event)</a><a class="headerlink" href="#qapidoc-179" title="Permalink to this headline">¶</a></h3> <p>Emitted when a memory failure occurs on host side.</p> <div class="section" id="qapidoc-176"> <h4>Arguments<a class="headerlink" href="#qapidoc-176" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">recipient</span></code>: <code class="docutils literal notranslate"><span class="pre">MemoryFailureRecipient</span></code></dt> <dd>recipient is defined as <code class="docutils literal notranslate"><span class="pre">MemoryFailureRecipient</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">MemoryFailureAction</span></code></dt> <dd>action that has been taken. action is defined as <code class="docutils literal notranslate"><span class="pre">MemoryFailureAction</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">flags</span></code>: <code class="docutils literal notranslate"><span class="pre">MemoryFailureFlags</span></code></dt> <dd>flags for MemoryFailureAction. action is defined as <code class="docutils literal notranslate"><span class="pre">MemoryFailureFlags</span></code>.</dd> </dl> </div> <div class="section" id="qapidoc-177"> <h4>Since<a class="headerlink" href="#qapidoc-177" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-178"> <h4>Example<a class="headerlink" href="#qapidoc-178" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"MEMORY_FAILURE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"recipient"</span><span class="p">:</span> <span class="s2">"hypervisor"</span><span class="p">,</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"fatal"</span><span class="p">,</span> <span class="s2">"flags"</span><span class="p">:</span> <span class="p">{</span> <span class="s1">'action-required'</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-182"> <h3><a class="toc-backref" href="#id63"><code class="docutils literal notranslate"><span class="pre">MemoryFailureRecipient</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-182" title="Permalink to this headline">¶</a></h3> <p>Hardware memory failure occurs, handled by recipient.</p> <div class="section" id="qapidoc-180"> <h4>Values<a class="headerlink" href="#qapidoc-180" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">hypervisor</span></code></dt> <dd>memory failure at QEMU process address space. (none guest memory, but used by QEMU itself).</dd> <dt><code class="docutils literal notranslate"><span class="pre">guest</span></code></dt> <dd>memory failure at guest memory,</dd> </dl> </div> <div class="section" id="qapidoc-181"> <h4>Since<a class="headerlink" href="#qapidoc-181" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-185"> <h3><a class="toc-backref" href="#id64"><code class="docutils literal notranslate"><span class="pre">MemoryFailureAction</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-185" title="Permalink to this headline">¶</a></h3> <p>Actions taken by QEMU in response to a hardware memory failure.</p> <div class="section" id="qapidoc-183"> <h4>Values<a class="headerlink" href="#qapidoc-183" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ignore</span></code></dt> <dd>the memory failure could be ignored. This will only be the case for action-optional failures.</dd> <dt><code class="docutils literal notranslate"><span class="pre">inject</span></code></dt> <dd>memory failure occurred in guest memory, the guest enabled MCE handling mechanism, and QEMU could inject the MCE into the guest successfully.</dd> <dt><code class="docutils literal notranslate"><span class="pre">fatal</span></code></dt> <dd>the failure is unrecoverable. This occurs for action-required failures if the recipient is the hypervisor; QEMU will exit.</dd> <dt><code class="docutils literal notranslate"><span class="pre">reset</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-184"> <h4>Since<a class="headerlink" href="#qapidoc-184" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-188"> <h3><a class="toc-backref" href="#id65"><code class="docutils literal notranslate"><span class="pre">MemoryFailureFlags</span></code> (Object)</a><a class="headerlink" href="#qapidoc-188" title="Permalink to this headline">¶</a></h3> <p>Additional information on memory failures.</p> <div class="section" id="qapidoc-186"> <h4>Members<a class="headerlink" href="#qapidoc-186" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">action-required</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether a memory failure event is action-required or action-optional (e.g. a failure during memory scrub).</dd> <dt><code class="docutils literal notranslate"><span class="pre">recursive</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether the failure occurred while the previous failure was still in progress.</dd> </dl> </div> <div class="section" id="qapidoc-187"> <h4>Since<a class="headerlink" href="#qapidoc-187" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> </div> <div class="section" id="qapidoc-189"> <h2><a class="toc-backref" href="#id66">Cryptography</a><a class="headerlink" href="#qapidoc-189" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-192"> <h3><a class="toc-backref" href="#id67"><code class="docutils literal notranslate"><span class="pre">QCryptoTLSCredsEndpoint</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-192" title="Permalink to this headline">¶</a></h3> <p>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.</p> <div class="section" id="qapidoc-190"> <h4>Values<a class="headerlink" href="#qapidoc-190" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code></dt> <dd>the network endpoint is acting as the client</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code></dt> <dd>the network endpoint is acting as the server</dd> </dl> </div> <div class="section" id="qapidoc-191"> <h4>Since<a class="headerlink" href="#qapidoc-191" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-195"> <h3><a class="toc-backref" href="#id68"><code class="docutils literal notranslate"><span class="pre">QCryptoSecretFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-195" title="Permalink to this headline">¶</a></h3> <p>The data format that the secret is provided in</p> <div class="section" id="qapidoc-193"> <h4>Values<a class="headerlink" href="#qapidoc-193" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">raw</span></code></dt> <dd>raw bytes. When encoded in JSON only valid UTF-8 sequences can be used</dd> <dt><code class="docutils literal notranslate"><span class="pre">base64</span></code></dt> <dd>arbitrary base64 encoded binary data</dd> </dl> </div> <div class="section" id="qapidoc-194"> <h4>Since<a class="headerlink" href="#qapidoc-194" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-198"> <h3><a class="toc-backref" href="#id69"><code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-198" title="Permalink to this headline">¶</a></h3> <p>The supported algorithms for computing content digests</p> <div class="section" id="qapidoc-196"> <h4>Values<a class="headerlink" href="#qapidoc-196" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">md5</span></code></dt> <dd>MD5. Should not be used in any new code, legacy compat only</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha1</span></code></dt> <dd>SHA-1. Should not be used in any new code, legacy compat only</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha224</span></code></dt> <dd>SHA-224. (since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha256</span></code></dt> <dd>SHA-256. Current recommended strong hash.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha384</span></code></dt> <dd>SHA-384. (since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha512</span></code></dt> <dd>SHA-512. (since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ripemd160</span></code></dt> <dd>RIPEMD-160. (since 2.7)</dd> </dl> </div> <div class="section" id="qapidoc-197"> <h4>Since<a class="headerlink" href="#qapidoc-197" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-201"> <h3><a class="toc-backref" href="#id70"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-201" title="Permalink to this headline">¶</a></h3> <p>The supported algorithms for content encryption ciphers</p> <div class="section" id="qapidoc-199"> <h4>Values<a class="headerlink" href="#qapidoc-199" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">aes-128</span></code></dt> <dd>AES with 128 bit / 16 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">aes-192</span></code></dt> <dd>AES with 192 bit / 24 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">aes-256</span></code></dt> <dd>AES with 256 bit / 32 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">des</span></code></dt> <dd>DES with 56 bit / 8 byte keys. Do not use except in VNC. (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">3des</span></code></dt> <dd>3DES(EDE) with 192 bit / 24 byte keys (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cast5-128</span></code></dt> <dd>Cast5 with 128 bit / 16 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">serpent-128</span></code></dt> <dd>Serpent with 128 bit / 16 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">serpent-192</span></code></dt> <dd>Serpent with 192 bit / 24 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">serpent-256</span></code></dt> <dd>Serpent with 256 bit / 32 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">twofish-128</span></code></dt> <dd>Twofish with 128 bit / 16 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">twofish-192</span></code></dt> <dd>Twofish with 192 bit / 24 byte keys</dd> <dt><code class="docutils literal notranslate"><span class="pre">twofish-256</span></code></dt> <dd>Twofish with 256 bit / 32 byte keys</dd> </dl> </div> <div class="section" id="qapidoc-200"> <h4>Since<a class="headerlink" href="#qapidoc-200" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-204"> <h3><a class="toc-backref" href="#id71"><code class="docutils literal notranslate"><span class="pre">QCryptoCipherMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-204" title="Permalink to this headline">¶</a></h3> <p>The supported modes for content encryption ciphers</p> <div class="section" id="qapidoc-202"> <h4>Values<a class="headerlink" href="#qapidoc-202" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ecb</span></code></dt> <dd>Electronic Code Book</dd> <dt><code class="docutils literal notranslate"><span class="pre">cbc</span></code></dt> <dd>Cipher Block Chaining</dd> <dt><code class="docutils literal notranslate"><span class="pre">xts</span></code></dt> <dd>XEX with tweaked code book and ciphertext stealing</dd> <dt><code class="docutils literal notranslate"><span class="pre">ctr</span></code></dt> <dd>Counter (Since 2.8)</dd> </dl> </div> <div class="section" id="qapidoc-203"> <h4>Since<a class="headerlink" href="#qapidoc-203" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-207"> <h3><a class="toc-backref" href="#id72"><code class="docutils literal notranslate"><span class="pre">QCryptoIVGenAlgorithm</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-207" title="Permalink to this headline">¶</a></h3> <p>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.</p> <div class="section" id="qapidoc-205"> <h4>Values<a class="headerlink" href="#qapidoc-205" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">plain</span></code></dt> <dd>64-bit sector number truncated to 32-bits</dd> <dt><code class="docutils literal notranslate"><span class="pre">plain64</span></code></dt> <dd>64-bit sector number</dd> <dt><code class="docutils literal notranslate"><span class="pre">essiv</span></code></dt> <dd>64-bit sector number encrypted with a hash of the encryption key</dd> </dl> </div> <div class="section" id="qapidoc-206"> <h4>Since<a class="headerlink" href="#qapidoc-206" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-210"> <h3><a class="toc-backref" href="#id73"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-210" title="Permalink to this headline">¶</a></h3> <p>The supported full disk encryption formats</p> <div class="section" id="qapidoc-208"> <h4>Values<a class="headerlink" href="#qapidoc-208" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">qcow</span></code></dt> <dd>QCow/QCow2 built-in AES-CBC encryption. Use only for liberating data from old images.</dd> <dt><code class="docutils literal notranslate"><span class="pre">luks</span></code></dt> <dd>LUKS encryption format. Recommended for new images</dd> </dl> </div> <div class="section" id="qapidoc-209"> <h4>Since<a class="headerlink" href="#qapidoc-209" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-213"> <h3><a class="toc-backref" href="#id74"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code> (Object)</a><a class="headerlink" href="#qapidoc-213" title="Permalink to this headline">¶</a></h3> <p>The common options that apply to all full disk encryption formats</p> <div class="section" id="qapidoc-211"> <h4>Members<a class="headerlink" href="#qapidoc-211" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockFormat</span></code></dt> <dd>the encryption format</dd> </dl> </div> <div class="section" id="qapidoc-212"> <h4>Since<a class="headerlink" href="#qapidoc-212" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-216"> <h3><a class="toc-backref" href="#id75"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> (Object)</a><a class="headerlink" href="#qapidoc-216" title="Permalink to this headline">¶</a></h3> <p>The options that apply to QCow/QCow2 AES-CBC encryption format</p> <div class="section" id="qapidoc-214"> <h4>Members<a class="headerlink" href="#qapidoc-214" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.</dd> </dl> </div> <div class="section" id="qapidoc-215"> <h4>Since<a class="headerlink" href="#qapidoc-215" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-219"> <h3><a class="toc-backref" href="#id76"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code> (Object)</a><a class="headerlink" href="#qapidoc-219" title="Permalink to this headline">¶</a></h3> <p>The options that apply to LUKS encryption format</p> <div class="section" id="qapidoc-217"> <h4>Members<a class="headerlink" href="#qapidoc-217" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the ID of a QCryptoSecret object providing the decryption key. Mandatory except when probing image for metadata only.</dd> </dl> </div> <div class="section" id="qapidoc-218"> <h4>Since<a class="headerlink" href="#qapidoc-218" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-222"> <h3><a class="toc-backref" href="#id77"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptionsLUKS</span></code> (Object)</a><a class="headerlink" href="#qapidoc-222" title="Permalink to this headline">¶</a></h3> <p>The options that apply to LUKS encryption format initialization</p> <div class="section" id="qapidoc-220"> <h4>Members<a class="headerlink" href="#qapidoc-220" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cipher-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code> (optional)</dt> <dd>the cipher algorithm for data encryption Currently defaults to ‘aes-256’.</dd> <dt><code class="docutils literal notranslate"><span class="pre">cipher-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoCipherMode</span></code> (optional)</dt> <dd>the cipher mode for data encryption Currently defaults to ‘xts’</dd> <dt><code class="docutils literal notranslate"><span class="pre">ivgen-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoIVGenAlgorithm</span></code> (optional)</dt> <dd>the initialization vector generator Currently defaults to ‘plain64’</dd> <dt><code class="docutils literal notranslate"><span class="pre">ivgen-hash-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (optional)</dt> <dd>the initialization vector generator hash Currently defaults to ‘sha256’</dd> <dt><code class="docutils literal notranslate"><span class="pre">hash-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (optional)</dt> <dd>the master key hash algorithm Currently defaults to ‘sha256’</dd> <dt><code class="docutils literal notranslate"><span class="pre">iter-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of milliseconds to spend in PBKDF passphrase processing. Currently defaults to 2000. (since 2.8)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code></dl> </div> <div class="section" id="qapidoc-221"> <h4>Since<a class="headerlink" href="#qapidoc-221" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-225"> <h3><a class="toc-backref" href="#id78"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockOpenOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-225" title="Permalink to this headline">¶</a></h3> <p>The options that are available for all encryption formats when opening an existing volume</p> <div class="section" id="qapidoc-223"> <h4>Members<a class="headerlink" href="#qapidoc-223" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-224"> <h4>Since<a class="headerlink" href="#qapidoc-224" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-228"> <h3><a class="toc-backref" href="#id79"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-228" title="Permalink to this headline">¶</a></h3> <p>The options that are available for all encryption formats when initializing a new volume</p> <div class="section" id="qapidoc-226"> <h4>Members<a class="headerlink" href="#qapidoc-226" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-227"> <h4>Since<a class="headerlink" href="#qapidoc-227" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-231"> <h3><a class="toc-backref" href="#id80"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoBase</span></code> (Object)</a><a class="headerlink" href="#qapidoc-231" title="Permalink to this headline">¶</a></h3> <p>The common information that applies to all full disk encryption formats</p> <div class="section" id="qapidoc-229"> <h4>Members<a class="headerlink" href="#qapidoc-229" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockFormat</span></code></dt> <dd>the encryption format</dd> </dl> </div> <div class="section" id="qapidoc-230"> <h4>Since<a class="headerlink" href="#qapidoc-230" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-234"> <h3><a class="toc-backref" href="#id81"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKSSlot</span></code> (Object)</a><a class="headerlink" href="#qapidoc-234" title="Permalink to this headline">¶</a></h3> <p>Information about the LUKS block encryption key slot options</p> <div class="section" id="qapidoc-232"> <h4>Members<a class="headerlink" href="#qapidoc-232" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">active</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether the key slot is currently in use</dd> <dt><code class="docutils literal notranslate"><span class="pre">key-offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>offset to the key material in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">iters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of PBKDF2 iterations for key material</dd> <dt><code class="docutils literal notranslate"><span class="pre">stripes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of stripes for splitting key material</dd> </dl> </div> <div class="section" id="qapidoc-233"> <h4>Since<a class="headerlink" href="#qapidoc-233" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-237"> <h3><a class="toc-backref" href="#id82"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code> (Object)</a><a class="headerlink" href="#qapidoc-237" title="Permalink to this headline">¶</a></h3> <p>Information about the LUKS block encryption options</p> <div class="section" id="qapidoc-235"> <h4>Members<a class="headerlink" href="#qapidoc-235" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cipher-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code></dt> <dd>the cipher algorithm for data encryption</dd> <dt><code class="docutils literal notranslate"><span class="pre">cipher-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoCipherMode</span></code></dt> <dd>the cipher mode for data encryption</dd> <dt><code class="docutils literal notranslate"><span class="pre">ivgen-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoIVGenAlgorithm</span></code></dt> <dd>the initialization vector generator</dd> <dt><code class="docutils literal notranslate"><span class="pre">ivgen-hash-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code> (optional)</dt> <dd>the initialization vector generator hash</dd> <dt><code class="docutils literal notranslate"><span class="pre">hash-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoHashAlgorithm</span></code></dt> <dd>the master key hash algorithm</dd> <dt><code class="docutils literal notranslate"><span class="pre">payload-offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>offset to the payload data in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">master-key-iters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of PBKDF2 iterations for key material</dd> <dt><code class="docutils literal notranslate"><span class="pre">uuid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>unique identifier for the volume</dd> <dt><code class="docutils literal notranslate"><span class="pre">slots</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">QCryptoBlockInfoLUKSSlot</span></code></dt> <dd>information about each key slot</dd> </dl> </div> <div class="section" id="qapidoc-236"> <h4>Since<a class="headerlink" href="#qapidoc-236" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-240"> <h3><a class="toc-backref" href="#id83"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-240" title="Permalink to this headline">¶</a></h3> <p>Information about the block encryption options</p> <div class="section" id="qapidoc-238"> <h4>Members<a class="headerlink" href="#qapidoc-238" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoBase</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-239"> <h4>Since<a class="headerlink" href="#qapidoc-239" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-243"> <h3><a class="toc-backref" href="#id84"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockLUKSKeyslotState</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-243" title="Permalink to this headline">¶</a></h3> <p>Defines state of keyslots that are affected by the update</p> <div class="section" id="qapidoc-241"> <h4>Values<a class="headerlink" href="#qapidoc-241" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">active</span></code></dt> <dd>The slots contain the given password and marked as active</dd> <dt><code class="docutils literal notranslate"><span class="pre">inactive</span></code></dt> <dd>The slots are erased (contain garbage) and marked as inactive</dd> </dl> </div> <div class="section" id="qapidoc-242"> <h4>Since<a class="headerlink" href="#qapidoc-242" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-246"> <h3><a class="toc-backref" href="#id85"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptionsLUKS</span></code> (Object)</a><a class="headerlink" href="#qapidoc-246" title="Permalink to this headline">¶</a></h3> <p>This struct defines the update parameters that activate/de-activate set of keyslots</p> <div class="section" id="qapidoc-244"> <h4>Members<a class="headerlink" href="#qapidoc-244" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockLUKSKeyslotState</span></code></dt> <dd>the desired state of the keyslots</dd> <dt><code class="docutils literal notranslate"><span class="pre">new-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The ID of a QCryptoSecret object providing the password to be written into added active keyslots</dd> <dt><code class="docutils literal notranslate"><span class="pre">old-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Optional (for deactivation only) If given will deactivate all keyslots that match password located in QCryptoSecret with this ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">iter-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Optional (for activation only) Number of milliseconds to spend in PBKDF passphrase processing for the newly activated keyslot. Currently defaults to 2000.</dd> <dt><code class="docutils literal notranslate"><span class="pre">keyslot</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><p class="first">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.</p> <p class="last">For keyslot deactivation, this parameter specifies the exact keyslot to deactivate</p> </dd> <dt><code class="docutils literal notranslate"><span class="pre">secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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</dd> </dl> </div> <div class="section" id="qapidoc-245"> Since 5.1</div> </div> <div class="section" id="qapidoc-249"> <h3><a class="toc-backref" href="#id86"><code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-249" title="Permalink to this headline">¶</a></h3> <p>The options that are available for all encryption formats when amending encryption settings</p> <div class="section" id="qapidoc-247"> <h4>Members<a class="headerlink" href="#qapidoc-247" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsBase</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-248"> <h4>Since<a class="headerlink" href="#qapidoc-248" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-253"> <h3><a class="toc-backref" href="#id87"><code class="docutils literal notranslate"><span class="pre">SecretCommonProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-253" title="Permalink to this headline">¶</a></h3> <p>Properties for objects of classes derived from secret-common.</p> <div class="section" id="qapidoc-250"> <h4>Members<a class="headerlink" href="#qapidoc-250" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">loaded</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the secret is loaded immediately when applying this option and will probably fail when processing the next option. Don’t use; only provided for compatibility. (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoSecretFormat</span></code> (optional)</dt> <dd>the data format that the secret is provided in (default: raw)</dd> <dt><code class="docutils literal notranslate"><span class="pre">keyid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of another secret that should be used to decrypt the provided data. If not present, the data is assumed to be unencrypted.</dd> <dt><code class="docutils literal notranslate"><span class="pre">iv</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the random initialization vector used for encryption of this particular secret. Should be a base64 encrypted string of the 16-byte IV. Mandatory if <code class="docutils literal notranslate"><span class="pre">keyid</span></code> is given. Ignored if <code class="docutils literal notranslate"><span class="pre">keyid</span></code> is absent.</dd> </dl> </div> <div class="section" id="qapidoc-251"> <h4>Features<a class="headerlink" href="#qapidoc-251" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">loaded</span></code> is deprecated. Setting true doesn’t make sense, and false is already the default.</dd> </dl> </div> <div class="section" id="qapidoc-252"> <h4>Since<a class="headerlink" href="#qapidoc-252" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-256"> <h3><a class="toc-backref" href="#id88"><code class="docutils literal notranslate"><span class="pre">SecretProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-256" title="Permalink to this headline">¶</a></h3> <p>Properties for secret objects.</p> <p>Either <code class="docutils literal notranslate"><span class="pre">data</span></code> or <code class="docutils literal notranslate"><span class="pre">file</span></code> must be provided, but not both.</p> <div class="section" id="qapidoc-254"> <h4>Members<a class="headerlink" href="#qapidoc-254" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the associated with the secret from</dd> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the filename to load the data associated with the secret from</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SecretCommonProperties</span></code></dl> </div> <div class="section" id="qapidoc-255"> <h4>Since<a class="headerlink" href="#qapidoc-255" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-259"> <h3><a class="toc-backref" href="#id89"><code class="docutils literal notranslate"><span class="pre">SecretKeyringProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-259" title="Permalink to this headline">¶</a></h3> <p>Properties for secret_keyring objects.</p> <div class="section" id="qapidoc-257"> <h4>Members<a class="headerlink" href="#qapidoc-257" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">serial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>serial number that identifies a key to get from the kernel</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SecretCommonProperties</span></code></dl> </div> <div class="section" id="qapidoc-258"> <h4>Since<a class="headerlink" href="#qapidoc-258" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-262"> <h3><a class="toc-backref" href="#id90"><code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-262" title="Permalink to this headline">¶</a></h3> <p>Properties for objects of classes derived from tls-creds.</p> <div class="section" id="qapidoc-260"> <h4>Members<a class="headerlink" href="#qapidoc-260" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">verify-peer</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true the peer credentials will be verified once the handshake is completed. This is a no-op for anonymous credentials. (default: true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dir</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the path of the directory that contains the credential files</dd> <dt><code class="docutils literal notranslate"><span class="pre">endpoint</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoTLSCredsEndpoint</span></code> (optional)</dt> <dd>whether the QEMU network backend that uses the credentials will be acting as a client or as a server (default: client)</dd> <dt><code class="docutils literal notranslate"><span class="pre">priority</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>a gnutls priority string as described at <a class="reference external" href="https://gnutls.org/manual/html_node/Priority-Strings.html">https://gnutls.org/manual/html_node/Priority-Strings.html</a></dd> </dl> </div> <div class="section" id="qapidoc-261"> <h4>Since<a class="headerlink" href="#qapidoc-261" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-266"> <h3><a class="toc-backref" href="#id91"><code class="docutils literal notranslate"><span class="pre">TlsCredsAnonProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-266" title="Permalink to this headline">¶</a></h3> <p>Properties for tls-creds-anon objects.</p> <div class="section" id="qapidoc-263"> <h4>Members<a class="headerlink" href="#qapidoc-263" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">loaded</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code></dl> </div> <div class="section" id="qapidoc-264"> <h4>Features<a class="headerlink" href="#qapidoc-264" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">loaded</span></code> is deprecated. Setting true doesn’t make sense, and false is already the default.</dd> </dl> </div> <div class="section" id="qapidoc-265"> <h4>Since<a class="headerlink" href="#qapidoc-265" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-270"> <h3><a class="toc-backref" href="#id92"><code class="docutils literal notranslate"><span class="pre">TlsCredsPskProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-270" title="Permalink to this headline">¶</a></h3> <p>Properties for tls-creds-psk objects.</p> <div class="section" id="qapidoc-267"> <h4>Members<a class="headerlink" href="#qapidoc-267" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">loaded</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">username</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code></dl> </div> <div class="section" id="qapidoc-268"> <h4>Features<a class="headerlink" href="#qapidoc-268" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">loaded</span></code> is deprecated. Setting true doesn’t make sense, and false is already the default.</dd> </dl> </div> <div class="section" id="qapidoc-269"> <h4>Since<a class="headerlink" href="#qapidoc-269" title="Permalink to this headline">¶</a></h4> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-274"> <h3><a class="toc-backref" href="#id93"><code class="docutils literal notranslate"><span class="pre">TlsCredsX509Properties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-274" title="Permalink to this headline">¶</a></h3> <p>Properties for tls-creds-x509 objects.</p> <div class="section" id="qapidoc-271"> <h4>Members<a class="headerlink" href="#qapidoc-271" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">loaded</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the credentials are loaded immediately when applying this option and will ignore options that are processed later. Don’t use; only provided for compatibility. (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">sanity-check</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, perform some sanity checks before using the credentials (default: true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">passwordid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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 <code class="docutils literal notranslate"><span class="pre">passwordid</span></code> parameter. This provides the ID of a previously created secret object containing the password for decryption.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code></dl> </div> <div class="section" id="qapidoc-272"> <h4>Features<a class="headerlink" href="#qapidoc-272" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">loaded</span></code> is deprecated. Setting true doesn’t make sense, and false is already the default.</dd> </dl> </div> <div class="section" id="qapidoc-273"> <h4>Since<a class="headerlink" href="#qapidoc-273" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> </div> <div class="section" id="qapidoc-275"> <h2><a class="toc-backref" href="#id94">Block devices</a><a class="headerlink" href="#qapidoc-275" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-276"> <h3><a class="toc-backref" href="#id95">Block core (VM unrelated)</a><a class="headerlink" href="#qapidoc-276" title="Permalink to this headline">¶</a></h3> </div> <div class="section" id="qapidoc-277"> <h3><a class="toc-backref" href="#id96">Background jobs</a><a class="headerlink" href="#qapidoc-277" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-280"> <h4><code class="docutils literal notranslate"><span class="pre">JobType</span></code> (Enum)<a class="headerlink" href="#qapidoc-280" title="Permalink to this headline">¶</a></h4> <p>Type of a background job.</p> <div class="section" id="qapidoc-278"> <h5>Values<a class="headerlink" href="#qapidoc-278" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">commit</span></code></dt> <dd>block commit job type, see “block-commit”</dd> <dt><code class="docutils literal notranslate"><span class="pre">stream</span></code></dt> <dd>block stream job type, see “block-stream”</dd> <dt><code class="docutils literal notranslate"><span class="pre">mirror</span></code></dt> <dd>drive mirror job type, see “drive-mirror”</dd> <dt><code class="docutils literal notranslate"><span class="pre">backup</span></code></dt> <dd>drive backup job type, see “drive-backup”</dd> <dt><code class="docutils literal notranslate"><span class="pre">create</span></code></dt> <dd>image creation job type, see “blockdev-create” (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">amend</span></code></dt> <dd>image options amend job type, see “x-blockdev-amend” (since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-load</span></code></dt> <dd>snapshot load job type, see “snapshot-load” (since 6.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-save</span></code></dt> <dd>snapshot save job type, see “snapshot-save” (since 6.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-delete</span></code></dt> <dd>snapshot delete job type, see “snapshot-delete” (since 6.0)</dd> </dl> </div> <div class="section" id="qapidoc-279"> <h5>Since<a class="headerlink" href="#qapidoc-279" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-283"> <h4><code class="docutils literal notranslate"><span class="pre">JobStatus</span></code> (Enum)<a class="headerlink" href="#qapidoc-283" title="Permalink to this headline">¶</a></h4> <p>Indicates the present state of a given job in its lifetime.</p> <div class="section" id="qapidoc-281"> <h5>Values<a class="headerlink" href="#qapidoc-281" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">undefined</span></code></dt> <dd>Erroneous, default state. Should not ever be visible.</dd> <dt><code class="docutils literal notranslate"><span class="pre">created</span></code></dt> <dd>The job has been created, but not yet started.</dd> <dt><code class="docutils literal notranslate"><span class="pre">running</span></code></dt> <dd>The job is currently running.</dd> <dt><code class="docutils literal notranslate"><span class="pre">paused</span></code></dt> <dd>The job is running, but paused. The pause may be requested by either the QMP user or by internal processes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">ready</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">standby</span></code></dt> <dd>The job is ready, but paused. This is nearly identical to <code class="docutils literal notranslate"><span class="pre">paused</span></code>. The job may return to <code class="docutils literal notranslate"><span class="pre">ready</span></code> or otherwise be canceled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">waiting</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">pending</span></code></dt> <dd>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 <code class="docutils literal notranslate"><span class="pre">job-finalize</span></code> if auto-finalize was set to false. These pending changes may still fail.</dd> <dt><code class="docutils literal notranslate"><span class="pre">aborting</span></code></dt> <dd>The job is in the process of being aborted, and will finish with an error. The job will afterwards report that it is <code class="docutils literal notranslate"><span class="pre">concluded</span></code>. This status may not be visible to the management process.</dd> <dt><code class="docutils literal notranslate"><span class="pre">concluded</span></code></dt> <dd>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 <code class="docutils literal notranslate"><span class="pre">job-dismiss</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">null</span></code></dt> <dd>The job is in the process of being dismantled. This state should not ever be visible externally.</dd> </dl> </div> <div class="section" id="qapidoc-282"> <h5>Since<a class="headerlink" href="#qapidoc-282" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-286"> <h4><code class="docutils literal notranslate"><span class="pre">JobVerb</span></code> (Enum)<a class="headerlink" href="#qapidoc-286" title="Permalink to this headline">¶</a></h4> <p>Represents command verbs that can be applied to a job.</p> <div class="section" id="qapidoc-284"> <h5>Values<a class="headerlink" href="#qapidoc-284" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cancel</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-cancel</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-pause</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">resume</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-resume</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">set-speed</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">block-job-set-speed</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">complete</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-complete</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">dismiss</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-dismiss</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">finalize</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">job-finalize</span></code></dd> </dl> </div> <div class="section" id="qapidoc-285"> <h5>Since<a class="headerlink" href="#qapidoc-285" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-289"> <h4><code class="docutils literal notranslate"><span class="pre">JOB_STATUS_CHANGE</span></code> (Event)<a class="headerlink" href="#qapidoc-289" title="Permalink to this headline">¶</a></h4> <p>Emitted when a job transitions to a different status.</p> <div class="section" id="qapidoc-287"> <h5>Arguments<a class="headerlink" href="#qapidoc-287" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">JobStatus</span></code></dt> <dd>The new job status</dd> </dl> </div> <div class="section" id="qapidoc-288"> <h5>Since<a class="headerlink" href="#qapidoc-288" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-292"> <h4><code class="docutils literal notranslate"><span class="pre">job-pause</span></code> (Command)<a class="headerlink" href="#qapidoc-292" title="Permalink to this headline">¶</a></h4> <p>Pause an active job.</p> <p>This command returns immediately after marking the active job for pausing. Pausing an already paused job is an error.</p> <p>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.</p> <p>Cancelling a paused job automatically resumes it.</p> <div class="section" id="qapidoc-290"> <h5>Arguments<a class="headerlink" href="#qapidoc-290" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-291"> <h5>Since<a class="headerlink" href="#qapidoc-291" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-295"> <h4><code class="docutils literal notranslate"><span class="pre">job-resume</span></code> (Command)<a class="headerlink" href="#qapidoc-295" title="Permalink to this headline">¶</a></h4> <p>Resume a paused job.</p> <p>This command returns immediately after resuming a paused job. Resuming an already running job is an error.</p> <p><code class="docutils literal notranslate"><span class="pre">id</span></code> : The job identifier.</p> <div class="section" id="qapidoc-293"> <h5>Arguments<a class="headerlink" href="#qapidoc-293" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-294"> <h5>Since<a class="headerlink" href="#qapidoc-294" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-298"> <h4><code class="docutils literal notranslate"><span class="pre">job-cancel</span></code> (Command)<a class="headerlink" href="#qapidoc-298" title="Permalink to this headline">¶</a></h4> <p>Instruct an active background job to cancel at the next opportunity. This command returns immediately after marking the active job for cancellation.</p> <p>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.</p> <div class="section" id="qapidoc-296"> <h5>Arguments<a class="headerlink" href="#qapidoc-296" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-297"> <h5>Since<a class="headerlink" href="#qapidoc-297" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-301"> <h4><code class="docutils literal notranslate"><span class="pre">job-complete</span></code> (Command)<a class="headerlink" href="#qapidoc-301" title="Permalink to this headline">¶</a></h4> <p>Manually trigger completion of an active job in the READY state.</p> <div class="section" id="qapidoc-299"> <h5>Arguments<a class="headerlink" href="#qapidoc-299" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-300"> <h5>Since<a class="headerlink" href="#qapidoc-300" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-304"> <h4><code class="docutils literal notranslate"><span class="pre">job-dismiss</span></code> (Command)<a class="headerlink" href="#qapidoc-304" title="Permalink to this headline">¶</a></h4> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-302"> <h5>Arguments<a class="headerlink" href="#qapidoc-302" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-303"> <h5>Since<a class="headerlink" href="#qapidoc-303" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-307"> <h4><code class="docutils literal notranslate"><span class="pre">job-finalize</span></code> (Command)<a class="headerlink" href="#qapidoc-307" title="Permalink to this headline">¶</a></h4> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-305"> <h5>Arguments<a class="headerlink" href="#qapidoc-305" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The identifier of any job in the transaction, or of a job that is not part of any transaction.</dd> </dl> </div> <div class="section" id="qapidoc-306"> <h5>Since<a class="headerlink" href="#qapidoc-306" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-310"> <h4><code class="docutils literal notranslate"><span class="pre">JobInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-310" title="Permalink to this headline">¶</a></h4> <p>Information about a job.</p> <div class="section" id="qapidoc-308"> <h5>Members<a class="headerlink" href="#qapidoc-308" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">JobType</span></code></dt> <dd>The kind of job that is being performed</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">JobStatus</span></code></dt> <dd>Current job state/status</dd> <dt><code class="docutils literal notranslate"><span class="pre">current-progress</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Progress made until now. The unit is arbitrary and the value can only meaningfully be used for the ratio of <code class="docutils literal notranslate"><span class="pre">current-progress</span></code> to <code class="docutils literal notranslate"><span class="pre">total-progress</span></code>. The value is monotonically increasing.</dd> <dt><code class="docutils literal notranslate"><span class="pre">total-progress</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Estimated <code class="docutils literal notranslate"><span class="pre">current-progress</span></code> value at the completion of the job. This value can arbitrarily change while the job is running, in both directions.</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd><p class="first">If this field is present, the job failed; if it is still missing in the CONCLUDED state, this indicates successful completion.</p> <p class="last">The value is a human-readable error message to describe the reason for the job failure. It should not be parsed by applications.</p> </dd> </dl> </div> <div class="section" id="qapidoc-309"> <h5>Since<a class="headerlink" href="#qapidoc-309" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-313"> <h4><code class="docutils literal notranslate"><span class="pre">query-jobs</span></code> (Command)<a class="headerlink" href="#qapidoc-313" title="Permalink to this headline">¶</a></h4> <p>Return information about jobs.</p> <div class="section" id="qapidoc-311"> <h5>Returns<a class="headerlink" href="#qapidoc-311" title="Permalink to this headline">¶</a></h5> <p>a list with a <code class="docutils literal notranslate"><span class="pre">JobInfo</span></code> for each active job</p> </div> <div class="section" id="qapidoc-312"> <h5>Since<a class="headerlink" href="#qapidoc-312" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-316"> <h4><code class="docutils literal notranslate"><span class="pre">SnapshotInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-316" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-314"> <h5>Members<a class="headerlink" href="#qapidoc-314" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>unique snapshot id</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>user chosen name</dd> <dt><code class="docutils literal notranslate"><span class="pre">vm-state-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of the VM state</dd> <dt><code class="docutils literal notranslate"><span class="pre">date-sec</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>UTC date of the snapshot in seconds</dd> <dt><code class="docutils literal notranslate"><span class="pre">date-nsec</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>fractional part in nano seconds to be used with date-sec</dd> <dt><code class="docutils literal notranslate"><span class="pre">vm-clock-sec</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>VM clock relative to boot in seconds</dd> <dt><code class="docutils literal notranslate"><span class="pre">vm-clock-nsec</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>fractional part in nano seconds to be used with vm-clock-sec</dd> <dt><code class="docutils literal notranslate"><span class="pre">icount</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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 <code class="docutils literal notranslate"><span class="pre">query-replay</span></code> command (since 5.2)</dd> </dl> </div> <div class="section" id="qapidoc-315"> <h5>Since<a class="headerlink" href="#qapidoc-315" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-319"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2EncryptionBase</span></code> (Object)<a class="headerlink" href="#qapidoc-319" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-317"> <h5>Members<a class="headerlink" href="#qapidoc-317" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcow2EncryptionFormat</span></code></dt> <dd>The encryption format</dd> </dl> </div> <div class="section" id="qapidoc-318"> <h5>Since<a class="headerlink" href="#qapidoc-318" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-322"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2Encryption</span></code> (Object)<a class="headerlink" href="#qapidoc-322" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-320"> <h5>Members<a class="headerlink" href="#qapidoc-320" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2EncryptionBase</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-321"> <h5>Since<a class="headerlink" href="#qapidoc-321" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-325"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2</span></code> (Object)<a class="headerlink" href="#qapidoc-325" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-323"> <h5>Members<a class="headerlink" href="#qapidoc-323" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">compat</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>compatibility level</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-file-raw</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True if the external data file must stay valid as a standalone (read-only) raw image without looking at qcow2 metadata (since: 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">extended-l2</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the image has extended L2 entries; only valid for compat >= 1.1 (since 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">lazy-refcounts</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>on or off; only valid for compat >= 1.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">corrupt</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the image has been marked corrupt; only valid for compat >= 1.1 (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">refcount-bits</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>width of a refcount entry in bits (since 2.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2Encryption</span></code> (optional)</dt> <dd>details about encryption parameters; only set if image is encrypted (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">Qcow2BitmapInfo</span></code> (optional)</dt> <dd>A list of qcow2 bitmap details (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compression-type</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2CompressionType</span></code></dt> <dd>the image cluster compression method (since 5.1)</dd> </dl> </div> <div class="section" id="qapidoc-324"> <h5>Since<a class="headerlink" href="#qapidoc-324" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-328"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificVmdk</span></code> (Object)<a class="headerlink" href="#qapidoc-328" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-326"> <h5>Members<a class="headerlink" href="#qapidoc-326" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">create-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The create type of VMDK image</dd> <dt><code class="docutils literal notranslate"><span class="pre">cid</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Content id of image</dd> <dt><code class="docutils literal notranslate"><span class="pre">parent-cid</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Parent VMDK image’s cid</dd> <dt><code class="docutils literal notranslate"><span class="pre">extents</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">ImageInfo</span></code></dt> <dd>List of extent files</dd> </dl> </div> <div class="section" id="qapidoc-327"> <h5>Since<a class="headerlink" href="#qapidoc-327" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-331"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificRbd</span></code> (Object)<a class="headerlink" href="#qapidoc-331" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-329"> <h5>Members<a class="headerlink" href="#qapidoc-329" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">encryption-format</span></code>: <code class="docutils literal notranslate"><span class="pre">RbdImageEncryptionFormat</span></code> (optional)</dt> <dd>Image encryption format</dd> </dl> </div> <div class="section" id="qapidoc-330"> <h5>Since<a class="headerlink" href="#qapidoc-330" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-334"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificKind</span></code> (Enum)<a class="headerlink" href="#qapidoc-334" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-332"> <h5>Values<a class="headerlink" href="#qapidoc-332" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">luks</span></code></dt> <dd>Since 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">rbd</span></code></dt> <dd>Since 6.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">qcow2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmdk</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-333"> <h5>Since<a class="headerlink" href="#qapidoc-333" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-337"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2Wrapper</span></code> (Object)<a class="headerlink" href="#qapidoc-337" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-335"> <h5>Members<a class="headerlink" href="#qapidoc-335" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-336"> <h5>Since<a class="headerlink" href="#qapidoc-336" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-340"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificVmdkWrapper</span></code> (Object)<a class="headerlink" href="#qapidoc-340" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-338"> <h5>Members<a class="headerlink" href="#qapidoc-338" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificVmdk</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-339"> <h5>Since<a class="headerlink" href="#qapidoc-339" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-343"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificLUKSWrapper</span></code> (Object)<a class="headerlink" href="#qapidoc-343" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-341"> <h5>Members<a class="headerlink" href="#qapidoc-341" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockInfoLUKS</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-342"> <h5>Since<a class="headerlink" href="#qapidoc-342" title="Permalink to this headline">¶</a></h5> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-346"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificRbdWrapper</span></code> (Object)<a class="headerlink" href="#qapidoc-346" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-344"> <h5>Members<a class="headerlink" href="#qapidoc-344" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificRbd</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-345"> <h5>Since<a class="headerlink" href="#qapidoc-345" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-349"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfoSpecific</span></code> (Object)<a class="headerlink" href="#qapidoc-349" title="Permalink to this headline">¶</a></h4> <p>A discriminated record of image format specific information structures.</p> <div class="section" id="qapidoc-347"> <h5>Members<a class="headerlink" href="#qapidoc-347" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificKind</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificQCow2Wrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow2"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificVmdkWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vmdk"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificLUKSWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecificRbdWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"rbd"</span></code></dl> </div> <div class="section" id="qapidoc-348"> <h5>Since<a class="headerlink" href="#qapidoc-348" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-352"> <h4><code class="docutils literal notranslate"><span class="pre">ImageInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-352" title="Permalink to this headline">¶</a></h4> <p>Information about a QEMU image file</p> <div class="section" id="qapidoc-350"> <h5>Members<a class="headerlink" href="#qapidoc-350" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>format of the image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">virtual-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum capacity in bytes of the image</dd> <dt><code class="docutils literal notranslate"><span class="pre">actual-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>actual size on disk in bytes of the image</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-flag</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if image is not cleanly closed</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>size of a cluster in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypted</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the image is encrypted</dd> <dt><code class="docutils literal notranslate"><span class="pre">compressed</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the image is compressed (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the backing file</dd> <dt><code class="docutils literal notranslate"><span class="pre">full-backing-filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>full path of the backing file</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-filename-format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the format of the backing file</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshots</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SnapshotInfo</span></code> (optional)</dt> <dd>list of VM snapshots</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-image</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfo</span></code> (optional)</dt> <dd>info of the backing image (since 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">format-specific</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfoSpecific</span></code> (optional)</dt> <dd>structure supplying additional format-specific information (since 1.7)</dd> </dl> </div> <div class="section" id="qapidoc-351"> <h5>Since<a class="headerlink" href="#qapidoc-351" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-355"> <h4><code class="docutils literal notranslate"><span class="pre">ImageCheck</span></code> (Object)<a class="headerlink" href="#qapidoc-355" title="Permalink to this headline">¶</a></h4> <p>Information about a QEMU image file check</p> <div class="section" id="qapidoc-353"> <h5>Members<a class="headerlink" href="#qapidoc-353" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the image file checked</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>format of the image file checked</dd> <dt><code class="docutils literal notranslate"><span class="pre">check-errors</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of unexpected errors occurred during check</dd> <dt><code class="docutils literal notranslate"><span class="pre">image-end-offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>offset (in bytes) where the image ends, this field is present if the driver for the image format supports it</dd> <dt><code class="docutils literal notranslate"><span class="pre">corruptions</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of corruptions found during the check if any</dd> <dt><code class="docutils literal notranslate"><span class="pre">leaks</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of leaks found during the check if any</dd> <dt><code class="docutils literal notranslate"><span class="pre">corruptions-fixed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of corruptions fixed during the check if any</dd> <dt><code class="docutils literal notranslate"><span class="pre">leaks-fixed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of leaks fixed during the check if any</dd> <dt><code class="docutils literal notranslate"><span class="pre">total-clusters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total number of clusters, this field is present if the driver for the image format supports it</dd> <dt><code class="docutils literal notranslate"><span class="pre">allocated-clusters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total number of allocated clusters, this field is present if the driver for the image format supports it</dd> <dt><code class="docutils literal notranslate"><span class="pre">fragmented-clusters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total number of fragmented clusters, this field is present if the driver for the image format supports it</dd> <dt><code class="docutils literal notranslate"><span class="pre">compressed-clusters</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total number of compressed clusters, this field is present if the driver for the image format supports it</dd> </dl> </div> <div class="section" id="qapidoc-354"> <h5>Since<a class="headerlink" href="#qapidoc-354" title="Permalink to this headline">¶</a></h5> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-358"> <h4><code class="docutils literal notranslate"><span class="pre">MapEntry</span></code> (Object)<a class="headerlink" href="#qapidoc-358" title="Permalink to this headline">¶</a></h4> <p>Mapping information from a virtual block range to a host file range</p> <div class="section" id="qapidoc-356"> <h5>Members<a class="headerlink" href="#qapidoc-356" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">start</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>virtual (guest) offset of the first byte described by this entry</dd> <dt><code class="docutils literal notranslate"><span class="pre">length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the number of bytes of the mapped virtual range</dd> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>reading the image will actually read data from a file (in particular, if <code class="docutils literal notranslate"><span class="pre">offset</span></code> is present this means that the sectors are not simply preallocated, but contain actual data in raw format)</dd> <dt><code class="docutils literal notranslate"><span class="pre">zero</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether the virtual blocks read as zeroes</dd> <dt><code class="docutils literal notranslate"><span class="pre">depth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>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</dd> <dt><code class="docutils literal notranslate"><span class="pre">present</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if this layer provides the data, false if adding a backing layer could impact this region (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if present, the image file stores the data for this range in raw format at the given (host) offset</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>filename that is referred to by <code class="docutils literal notranslate"><span class="pre">offset</span></code></dd> </dl> </div> <div class="section" id="qapidoc-357"> <h5>Since<a class="headerlink" href="#qapidoc-357" title="Permalink to this headline">¶</a></h5> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-361"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCacheInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-361" title="Permalink to this headline">¶</a></h4> <p>Cache mode information for a block device</p> <div class="section" id="qapidoc-359"> <h5>Members<a class="headerlink" href="#qapidoc-359" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">writeback</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if writeback mode is enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">direct</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the host page cache is bypassed (O_DIRECT)</dd> <dt><code class="docutils literal notranslate"><span class="pre">no-flush</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if flush requests are ignored for the device</dd> </dl> </div> <div class="section" id="qapidoc-360"> <h5>Since<a class="headerlink" href="#qapidoc-360" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-364"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDeviceInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-364" title="Permalink to this headline">¶</a></h4> <p>Information about the backing device for a block device.</p> <div class="section" id="qapidoc-362"> <h5>Members<a class="headerlink" href="#qapidoc-362" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the filename of the backing device</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the block driver node (Since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ro</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the backing device was open read-only</dd> <dt><code class="docutils literal notranslate"><span class="pre">drv</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing_file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the backing file (for copy-on-write)</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing_file_depth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of files in the backing file chain (since: 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypted</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the backing device is encrypted</dd> <dt><code class="docutils literal notranslate"><span class="pre">detect_zeroes</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDetectZeroesOptions</span></code></dt> <dd>detect and optimize zero writes (Since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total throughput limit in bytes per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>read throughput limit in bytes per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>write throughput limit in bytes per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total I/O operations per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>read I/O operations per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>write I/O operations per second is specified</dd> <dt><code class="docutils literal notranslate"><span class="pre">image</span></code>: <code class="docutils literal notranslate"><span class="pre">ImageInfo</span></code></dt> <dd>the info of image used (since: 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>total throughput limit during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>read throughput limit during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>write throughput limit during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>total I/O operations per second during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>read I/O operations per second during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>write I/O operations per second during bursts,</dt> <dd>in bytes (Since 1.7)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_max</span></code> burst</dt> <dd>period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_rd_max</span></code></dt> <dd>burst period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_wr_max</span></code></dt> <dd>burst period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops</span></code> burst</dt> <dd>period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops_rd_max</span></code></dt> <dd>burst period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops_wr_max</span></code></dt> <dd>burst period, in seconds. (Since 2.6)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>an I/O size in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">group</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>throttle group name (Since 2.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevCacheInfo</span></code></dt> <dd>the cache mode used for the block device (since: 2.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">write_threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>configured write threshold for the device. 0 if disabled. (Since 2.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockDirtyInfo</span></code> (optional)</dt> <dd>dirty bitmaps information (only present if node has one or more dirty bitmaps) (Since 4.2)</dd> </dl> </div> <div class="section" id="qapidoc-363"> <h5>Since<a class="headerlink" href="#qapidoc-363" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-367"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDeviceIoStatus</span></code> (Enum)<a class="headerlink" href="#qapidoc-367" title="Permalink to this headline">¶</a></h4> <p>An enumeration of block device I/O status.</p> <div class="section" id="qapidoc-365"> <h5>Values<a class="headerlink" href="#qapidoc-365" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ok</span></code></dt> <dd>The last I/O operation has succeeded</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed</span></code></dt> <dd>The last I/O operation has failed</dd> <dt><code class="docutils literal notranslate"><span class="pre">nospace</span></code></dt> <dd>The last I/O operation has failed due to a no-space condition</dd> </dl> </div> <div class="section" id="qapidoc-366"> <h5>Since<a class="headerlink" href="#qapidoc-366" title="Permalink to this headline">¶</a></h5> <p>1.0</p> </div> </div> <div class="section" id="qapidoc-370"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-370" title="Permalink to this headline">¶</a></h4> <p>Block dirty bitmap information.</p> <div class="section" id="qapidoc-368"> <h5>Members<a class="headerlink" href="#qapidoc-368" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the dirty bitmap (Since 2.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of dirty bytes according to the dirty bitmap</dd> <dt><code class="docutils literal notranslate"><span class="pre">granularity</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>granularity of the dirty bitmap in bytes (since 1.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">recording</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the bitmap is recording new writes from the guest. Replaces <code class="docutils literal notranslate"><span class="pre">active</span></code> and <code class="docutils literal notranslate"><span class="pre">disabled</span></code> statuses. (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">busy</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the bitmap is in-use by some operation (NBD or jobs) and cannot be modified via QMP or used by another operation. Replaces <code class="docutils literal notranslate"><span class="pre">locked</span></code> and <code class="docutils literal notranslate"><span class="pre">frozen</span></code> statuses. (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">persistent</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the bitmap was stored on disk, is scheduled to be stored on disk, or both. (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">inconsistent</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if this is a persistent bitmap that was improperly stored. Implies <code class="docutils literal notranslate"><span class="pre">persistent</span></code> to be true; <code class="docutils literal notranslate"><span class="pre">recording</span></code> and <code class="docutils literal notranslate"><span class="pre">busy</span></code> to be false. This bitmap cannot be used. To remove it, use <code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-remove</span></code>. (Since 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-369"> <h5>Since<a class="headerlink" href="#qapidoc-369" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-373"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2BitmapInfoFlags</span></code> (Enum)<a class="headerlink" href="#qapidoc-373" title="Permalink to this headline">¶</a></h4> <p>An enumeration of flags that a bitmap can report to the user.</p> <div class="section" id="qapidoc-371"> <h5>Values<a class="headerlink" href="#qapidoc-371" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in-use</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>The bitmap must reflect all changes of the virtual disk by any application that would write to this qcow2 file.</dd> </dl> </div> <div class="section" id="qapidoc-372"> <h5>Since<a class="headerlink" href="#qapidoc-372" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-376"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2BitmapInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-376" title="Permalink to this headline">¶</a></h4> <p>Qcow2 bitmap information.</p> <div class="section" id="qapidoc-374"> <h5>Members<a class="headerlink" href="#qapidoc-374" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the bitmap</dd> <dt><code class="docutils literal notranslate"><span class="pre">granularity</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>granularity of the bitmap in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">flags</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">Qcow2BitmapInfoFlags</span></code></dt> <dd>flags of the bitmap</dd> </dl> </div> <div class="section" id="qapidoc-375"> <h5>Since<a class="headerlink" href="#qapidoc-375" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-380"> <h4><code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-380" title="Permalink to this headline">¶</a></h4> <p>Block latency histogram.</p> <div class="section" id="qapidoc-377"> <h5>Members<a class="headerlink" href="#qapidoc-377" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">boundaries</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code></dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">bins</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code></dt> <dd>list of io request counts corresponding to histogram intervals. len(<code class="docutils literal notranslate"><span class="pre">bins</span></code>) = len(<code class="docutils literal notranslate"><span class="pre">boundaries</span></code>) + 1 For the example above, <code class="docutils literal notranslate"><span class="pre">bins</span></code> may be something like [3, 1, 5, 2], and corresponding histogram looks like:</dd> </dl> </div> <div class="section" id="qapidoc-378"> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">5</span><span class="o">|</span> <span class="o">*</span> <span class="mi">4</span><span class="o">|</span> <span class="o">*</span> <span class="mi">3</span><span class="o">|</span> <span class="o">*</span> <span class="o">*</span> <span class="mi">2</span><span class="o">|</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="mi">1</span><span class="o">|</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">+------------------</span> <span class="mi">10</span> <span class="mi">50</span> <span class="mi">100</span> </pre></div> </div> </div> <div class="section" id="qapidoc-379"> <h5>Since<a class="headerlink" href="#qapidoc-379" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-383"> <h4><code class="docutils literal notranslate"><span class="pre">BlockInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-383" title="Permalink to this headline">¶</a></h4> <p>Block device information. This structure describes a virtual device and the backing device associated with it.</p> <div class="section" id="qapidoc-381"> <h5>Members<a class="headerlink" href="#qapidoc-381" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The device name associated with the virtual device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">qdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The qdev ID, or if no ID is assigned, the QOM path of the block device. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>This field is returned only for compatibility reasons, it should not be used (always returns ‘unknown’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">removable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>True if the device supports removable media.</dd> <dt><code class="docutils literal notranslate"><span class="pre">locked</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>True if the guest has locked this device from having its media removed</dd> <dt><code class="docutils literal notranslate"><span class="pre">tray_open</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True if the device’s tray is open (only present if it has a tray)</dd> <dt><code class="docutils literal notranslate"><span class="pre">io-status</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDeviceIoStatus</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">BlockDeviceIoStatus</span></code>. 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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">inserted</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDeviceInfo</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">BlockDeviceInfo</span></code> describing the device if media is present</dd> </dl> </div> <div class="section" id="qapidoc-382"> <h5>Since<a class="headerlink" href="#qapidoc-382" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-386"> <h4><code class="docutils literal notranslate"><span class="pre">BlockMeasureInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-386" title="Permalink to this headline">¶</a></h4> <p>Image file size calculation information. This structure describes the size requirements for creating a new image file.</p> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-384"> <h5>Members<a class="headerlink" href="#qapidoc-384" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">required</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size required for a new image file, in bytes, when copying just allocated guest-visible contents.</dd> <dt><code class="docutils literal notranslate"><span class="pre">fully-allocated</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Image file size, in bytes, once data has been written to all sectors, when copying just guest-visible contents.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-385"> <h5>Since<a class="headerlink" href="#qapidoc-385" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-390"> <h4><code class="docutils literal notranslate"><span class="pre">query-block</span></code> (Command)<a class="headerlink" href="#qapidoc-390" title="Permalink to this headline">¶</a></h4> <p>Get a list of BlockInfo for all virtual block devices.</p> <div class="section" id="qapidoc-387"> <h5>Returns<a class="headerlink" href="#qapidoc-387" title="Permalink to this headline">¶</a></h5> <p>a list of <code class="docutils literal notranslate"><span class="pre">BlockInfo</span></code> describing each virtual block device. Filter nodes that were created implicitly are skipped over.</p> </div> <div class="section" id="qapidoc-388"> <h5>Since<a class="headerlink" href="#qapidoc-388" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-389"> <h5>Example<a class="headerlink" href="#qapidoc-389" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-block"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"io-status"</span><span class="p">:</span> <span class="s2">"ok"</span><span class="p">,</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"ide0-hd0"</span><span class="p">,</span> <span class="s2">"locked"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"removable"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"inserted"</span><span class="p">:{</span> <span class="s2">"ro"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"drv"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"encrypted"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span><span class="s2">"disks/test.qcow2"</span><span class="p">,</span> <span class="s2">"backing_file_depth"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"bps"</span><span class="p">:</span><span class="mi">1000000</span><span class="p">,</span> <span class="s2">"bps_rd"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"iops"</span><span class="p">:</span><span class="mi">1000000</span><span class="p">,</span> <span class="s2">"iops_rd"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max"</span><span class="p">:</span> <span class="mi">8000000</span><span class="p">,</span> <span class="s2">"bps_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_size"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"detect_zeroes"</span><span class="p">:</span> <span class="s2">"on"</span><span class="p">,</span> <span class="s2">"write_threshold"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"image"</span><span class="p">:{</span> <span class="s2">"filename"</span><span class="p">:</span><span class="s2">"disks/test.qcow2"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"virtual-size"</span><span class="p">:</span><span class="mi">2048000</span><span class="p">,</span> <span class="s2">"backing_file"</span><span class="p">:</span><span class="s2">"base.qcow2"</span><span class="p">,</span> <span class="s2">"full-backing-filename"</span><span class="p">:</span><span class="s2">"disks/base.qcow2"</span><span class="p">,</span> <span class="s2">"backing-filename-format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"snapshots"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot1"</span><span class="p">,</span> <span class="s2">"vm-state-size"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"date-sec"</span><span class="p">:</span> <span class="mi">10000200</span><span class="p">,</span> <span class="s2">"date-nsec"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> <span class="s2">"vm-clock-sec"</span><span class="p">:</span> <span class="mi">206</span><span class="p">,</span> <span class="s2">"vm-clock-nsec"</span><span class="p">:</span> <span class="mi">30</span> <span class="p">}</span> <span class="p">],</span> <span class="s2">"backing-image"</span><span class="p">:{</span> <span class="s2">"filename"</span><span class="p">:</span><span class="s2">"disks/base.qcow2"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"virtual-size"</span><span class="p">:</span><span class="mi">2048000</span> <span class="p">}</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"ide_disk"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span><span class="s2">"unknown"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"io-status"</span><span class="p">:</span> <span class="s2">"ok"</span><span class="p">,</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"locked"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"removable"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[23]"</span><span class="p">,</span> <span class="s2">"tray_open"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span><span class="s2">"unknown"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"floppy0"</span><span class="p">,</span> <span class="s2">"locked"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"removable"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[20]"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span><span class="s2">"unknown"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"sd0"</span><span class="p">,</span> <span class="s2">"locked"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"removable"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span><span class="s2">"unknown"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-393"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDeviceTimedStats</span></code> (Object)<a class="headerlink" href="#qapidoc-393" title="Permalink to this headline">¶</a></h4> <p>Statistics of a block device during a given interval of time.</p> <div class="section" id="qapidoc-391"> <h5>Members<a class="headerlink" href="#qapidoc-391" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">interval_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Interval used for calculating the statistics, in seconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">min_rd_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Minimum latency of read operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">min_wr_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Minimum latency of write operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">min_flush_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Minimum latency of flush operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max_rd_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Maximum latency of read operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max_wr_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Maximum latency of write operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max_flush_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Maximum latency of flush operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">avg_rd_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Average latency of read operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">avg_wr_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Average latency of write operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">avg_flush_latency_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Average latency of flush operations in the defined interval, in nanoseconds.</dd> <dt><code class="docutils literal notranslate"><span class="pre">avg_rd_queue_depth</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>Average number of pending read operations in the defined interval.</dd> <dt><code class="docutils literal notranslate"><span class="pre">avg_wr_queue_depth</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>Average number of pending write operations in the defined interval.</dd> </dl> </div> <div class="section" id="qapidoc-392"> <h5>Since<a class="headerlink" href="#qapidoc-392" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-396"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDeviceStats</span></code> (Object)<a class="headerlink" href="#qapidoc-396" title="Permalink to this headline">¶</a></h4> <p>Statistics of a virtual block device or a block backing device.</p> <div class="section" id="qapidoc-394"> <h5>Members<a class="headerlink" href="#qapidoc-394" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">rd_bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes read by the device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes written by the device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap_bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes unmapped by the device (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rd_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of read operations performed by the device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of write operations performed by the device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of cache flush operations performed by the device (since 0.15)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of unmap operations performed by the device (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rd_total_time_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Total time spent on reads in nanoseconds (since 0.15).</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_total_time_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Total time spent on writes in nanoseconds (since 0.15).</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush_total_time_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Total time spent on cache flushes in nanoseconds (since 0.15).</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap_total_time_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Total time spent on unmap operations in nanoseconds (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_highest_offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">rd_merged</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of read requests that have been merged into another request (Since 2.3).</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_merged</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of write requests that have been merged into another request (Since 2.3).</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap_merged</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of unmap requests that have been merged into another request (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">idle_time_ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed_rd_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of failed read operations performed by the device (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed_wr_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of failed write operations performed by the device (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed_flush_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of failed flush operations performed by the device (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed_unmap_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of failed unmap operations performed by the device (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">invalid_rd_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd><dl class="first last docutils"> <dt>The number of invalid read operations</dt> <dd>performed by the device (Since 2.5)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">invalid_wr_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of invalid write operations performed by the device (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">invalid_flush_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of invalid flush operations performed by the device (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">invalid_unmap_operations</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of invalid unmap operations performed by the device (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">account_invalid</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Whether invalid operations are included in the last access statistics (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">account_failed</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Whether failed operations are included in the latency and last access statistics (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">timed_stats</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockDeviceTimedStats</span></code></dt> <dd>Statistics specific to the set of previously defined intervals of time (Since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rd_latency_histogram</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code>. (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">wr_latency_histogram</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code>. (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush_latency_histogram</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">BlockLatencyHistogramInfo</span></code>. (Since 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-395"> <h5>Since<a class="headerlink" href="#qapidoc-395" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-399"> <h4><code class="docutils literal notranslate"><span class="pre">BlockStatsSpecificFile</span></code> (Object)<a class="headerlink" href="#qapidoc-399" title="Permalink to this headline">¶</a></h4> <p>File driver statistics</p> <div class="section" id="qapidoc-397"> <h5>Members<a class="headerlink" href="#qapidoc-397" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">discard-nb-ok</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of successful discard operations performed by the driver.</dd> <dt><code class="docutils literal notranslate"><span class="pre">discard-nb-failed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of failed discard operations performed by the driver.</dd> <dt><code class="docutils literal notranslate"><span class="pre">discard-bytes-ok</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes discarded by the driver.</dd> </dl> </div> <div class="section" id="qapidoc-398"> <h5>Since<a class="headerlink" href="#qapidoc-398" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-402"> <h4><code class="docutils literal notranslate"><span class="pre">BlockStatsSpecificNvme</span></code> (Object)<a class="headerlink" href="#qapidoc-402" title="Permalink to this headline">¶</a></h4> <p>NVMe driver statistics</p> <div class="section" id="qapidoc-400"> <h5>Members<a class="headerlink" href="#qapidoc-400" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">completion-errors</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of completion errors.</dd> <dt><code class="docutils literal notranslate"><span class="pre">aligned-accesses</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of aligned accesses performed by the driver.</dd> <dt><code class="docutils literal notranslate"><span class="pre">unaligned-accesses</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of unaligned accesses performed by the driver.</dd> </dl> </div> <div class="section" id="qapidoc-401"> <h5>Since<a class="headerlink" href="#qapidoc-401" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-405"> <h4><code class="docutils literal notranslate"><span class="pre">BlockStatsSpecific</span></code> (Object)<a class="headerlink" href="#qapidoc-405" title="Permalink to this headline">¶</a></h4> <p>Block driver specific statistics</p> <div class="section" id="qapidoc-403"> <h5>Members<a class="headerlink" href="#qapidoc-403" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockStatsSpecificFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"file"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockStatsSpecificFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"host_device"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_HOST_BLOCK_DEVICE</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockStatsSpecificNvme</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"nvme"</span></code></dl> </div> <div class="section" id="qapidoc-404"> <h5>Since<a class="headerlink" href="#qapidoc-404" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-408"> <h4><code class="docutils literal notranslate"><span class="pre">BlockStats</span></code> (Object)<a class="headerlink" href="#qapidoc-408" title="Permalink to this headline">¶</a></h4> <p>Statistics of a virtual block device or a block backing device.</p> <div class="section" id="qapidoc-406"> <h5>Members<a class="headerlink" href="#qapidoc-406" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>If the stats are for a virtual block device, the name corresponding to the virtual block device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The node name of the device. (Since 2.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">qdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The qdev ID, or if no ID is assigned, the QOM path of the block device. (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">stats</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDeviceStats</span></code></dt> <dd>A <code class="docutils literal notranslate"><span class="pre">BlockDeviceStats</span></code> for the device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">driver-specific</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockStatsSpecific</span></code> (optional)</dt> <dd>Optional driver-specific stats. (Since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">parent</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockStats</span></code> (optional)</dt> <dd>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</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockStats</span></code> (optional)</dt> <dd>This describes the backing block device if it has one. (Since 2.0)</dd> </dl> </div> <div class="section" id="qapidoc-407"> <h5>Since<a class="headerlink" href="#qapidoc-407" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-413"> <h4><code class="docutils literal notranslate"><span class="pre">query-blockstats</span></code> (Command)<a class="headerlink" href="#qapidoc-413" title="Permalink to this headline">¶</a></h4> <p>Query the <code class="docutils literal notranslate"><span class="pre">BlockStats</span></code> for all virtual block devices.</p> <div class="section" id="qapidoc-409"> <h5>Arguments<a class="headerlink" href="#qapidoc-409" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">query-nodes</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-410"> <h5>Returns<a class="headerlink" href="#qapidoc-410" title="Permalink to this headline">¶</a></h5> <p>A list of <code class="docutils literal notranslate"><span class="pre">BlockStats</span></code> for each virtual block devices.</p> </div> <div class="section" id="qapidoc-411"> <h5>Since<a class="headerlink" href="#qapidoc-411" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-412"> <h5>Example<a class="headerlink" href="#qapidoc-412" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-blockstats"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"ide0-hd0"</span><span class="p">,</span> <span class="s2">"parent"</span><span class="p">:{</span> <span class="s2">"stats"</span><span class="p">:{</span> <span class="s2">"wr_highest_offset"</span><span class="p">:</span><span class="mi">3686448128</span><span class="p">,</span> <span class="s2">"wr_bytes"</span><span class="p">:</span><span class="mi">9786368</span><span class="p">,</span> <span class="s2">"wr_operations"</span><span class="p">:</span><span class="mi">751</span><span class="p">,</span> <span class="s2">"rd_bytes"</span><span class="p">:</span><span class="mi">122567168</span><span class="p">,</span> <span class="s2">"rd_operations"</span><span class="p">:</span><span class="mi">36772</span> <span class="s2">"wr_total_times_ns"</span><span class="p">:</span><span class="mi">313253456</span> <span class="s2">"rd_total_times_ns"</span><span class="p">:</span><span class="mi">3465673657</span> <span class="s2">"flush_total_times_ns"</span><span class="p">:</span><span class="mi">49653</span> <span class="s2">"flush_operations"</span><span class="p">:</span><span class="mi">61</span><span class="p">,</span> <span class="s2">"rd_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"idle_time_ns"</span><span class="p">:</span><span class="mi">2953431879</span><span class="p">,</span> <span class="s2">"account_invalid"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"account_failed"</span><span class="p">:</span><span class="n">false</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"stats"</span><span class="p">:{</span> <span class="s2">"wr_highest_offset"</span><span class="p">:</span><span class="mi">2821110784</span><span class="p">,</span> <span class="s2">"wr_bytes"</span><span class="p">:</span><span class="mi">9786368</span><span class="p">,</span> <span class="s2">"wr_operations"</span><span class="p">:</span><span class="mi">692</span><span class="p">,</span> <span class="s2">"rd_bytes"</span><span class="p">:</span><span class="mi">122739200</span><span class="p">,</span> <span class="s2">"rd_operations"</span><span class="p">:</span><span class="mi">36604</span> <span class="s2">"flush_operations"</span><span class="p">:</span><span class="mi">51</span><span class="p">,</span> <span class="s2">"wr_total_times_ns"</span><span class="p">:</span><span class="mi">313253456</span> <span class="s2">"rd_total_times_ns"</span><span class="p">:</span><span class="mi">3465673657</span> <span class="s2">"flush_total_times_ns"</span><span class="p">:</span><span class="mi">49653</span><span class="p">,</span> <span class="s2">"rd_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"idle_time_ns"</span><span class="p">:</span><span class="mi">2953431879</span><span class="p">,</span> <span class="s2">"account_invalid"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"account_failed"</span><span class="p">:</span><span class="n">false</span> <span class="p">},</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[23]"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"stats"</span><span class="p">:{</span> <span class="s2">"wr_highest_offset"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_operations"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"rd_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_total_times_ns"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"account_invalid"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"account_failed"</span><span class="p">:</span><span class="n">false</span> <span class="p">},</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[24]"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"floppy0"</span><span class="p">,</span> <span class="s2">"stats"</span><span class="p">:{</span> <span class="s2">"wr_highest_offset"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_operations"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"rd_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_total_times_ns"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"account_invalid"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"account_failed"</span><span class="p">:</span><span class="n">false</span> <span class="p">},</span> <span class="s2">"qdev"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[16]"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span><span class="s2">"sd0"</span><span class="p">,</span> <span class="s2">"stats"</span><span class="p">:{</span> <span class="s2">"wr_highest_offset"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_bytes"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_operations"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_operations"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"rd_total_times_ns"</span><span class="p">:</span><span class="mi">0</span> <span class="s2">"flush_total_times_ns"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"rd_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"wr_merged"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"account_invalid"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"account_failed"</span><span class="p">:</span><span class="n">false</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-416"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (Enum)<a class="headerlink" href="#qapidoc-416" title="Permalink to this headline">¶</a></h4> <p>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</p> <div class="section" id="qapidoc-414"> <h5>Values<a class="headerlink" href="#qapidoc-414" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">report</span></code></dt> <dd>for guest operations, report the error to the guest; for jobs, cancel the job</dd> <dt><code class="docutils literal notranslate"><span class="pre">ignore</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">enospc</span></code></dt> <dd>same as <code class="docutils literal notranslate"><span class="pre">stop</span></code> on ENOSPC, same as <code class="docutils literal notranslate"><span class="pre">report</span></code> otherwise.</dd> <dt><code class="docutils literal notranslate"><span class="pre">stop</span></code></dt> <dd>for guest operations, stop the virtual machine; for jobs, pause the job</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>inherit the error handling policy of the backend (since: 2.7)</dd> </dl> </div> <div class="section" id="qapidoc-415"> <h5>Since<a class="headerlink" href="#qapidoc-415" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-419"> <h4><code class="docutils literal notranslate"><span class="pre">MirrorSyncMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-419" title="Permalink to this headline">¶</a></h4> <p>An enumeration of possible behaviors for the initial synchronization phase of storage mirroring.</p> <div class="section" id="qapidoc-417"> <h5>Values<a class="headerlink" href="#qapidoc-417" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">top</span></code></dt> <dd>copies data in the topmost image to the destination</dd> <dt><code class="docutils literal notranslate"><span class="pre">full</span></code></dt> <dd>copies data from all images to the destination</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>only copy data written from now on</dd> <dt><code class="docutils literal notranslate"><span class="pre">incremental</span></code></dt> <dd>only copy data described by the dirty bitmap. (since: 2.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmap</span></code></dt> <dd>only copy data described by the dirty bitmap. (since: 4.2) Behavior on completion is determined by the BitmapSyncMode.</dd> </dl> </div> <div class="section" id="qapidoc-418"> <h5>Since<a class="headerlink" href="#qapidoc-418" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-422"> <h4><code class="docutils literal notranslate"><span class="pre">BitmapSyncMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-422" title="Permalink to this headline">¶</a></h4> <p>An enumeration of possible behaviors for the synchronization of a bitmap when used for data copy operations.</p> <div class="section" id="qapidoc-420"> <h5>Values<a class="headerlink" href="#qapidoc-420" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">on-success</span></code></dt> <dd>The bitmap is only synced when the operation is successful. This is the behavior always used for ‘INCREMENTAL’ backups.</dd> <dt><code class="docutils literal notranslate"><span class="pre">never</span></code></dt> <dd>The bitmap is never synchronized with the operation, and is treated solely as a read-only manifest of blocks to copy.</dd> <dt><code class="docutils literal notranslate"><span class="pre">always</span></code></dt> <dd>The bitmap is always synchronized with the operation, regardless of whether or not the operation was successful.</dd> </dl> </div> <div class="section" id="qapidoc-421"> <h5>Since<a class="headerlink" href="#qapidoc-421" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-425"> <h4><code class="docutils literal notranslate"><span class="pre">MirrorCopyMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-425" title="Permalink to this headline">¶</a></h4> <p>An enumeration whose values tell the mirror block job when to trigger writes to the target.</p> <div class="section" id="qapidoc-423"> <h5>Values<a class="headerlink" href="#qapidoc-423" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">background</span></code></dt> <dd>copy data in background only.</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-blocking</span></code></dt> <dd>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 <code class="docutils literal notranslate"><span class="pre">background</span></code> mode.</dd> </dl> </div> <div class="section" id="qapidoc-424"> <h5>Since<a class="headerlink" href="#qapidoc-424" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-428"> <h4><code class="docutils literal notranslate"><span class="pre">BlockJobInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-428" title="Permalink to this headline">¶</a></h4> <p>Information about a long-running block device operation.</p> <div class="section" id="qapidoc-426"> <h5>Members<a class="headerlink" href="#qapidoc-426" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the job type (‘stream’ for image streaming)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier. Originally the device name but other values are allowed since QEMU 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">len</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Estimated <code class="docutils literal notranslate"><span class="pre">offset</span></code> value at the completion of the job. This value can arbitrarily change while the job is running, in both directions.</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Progress made until now. The unit is arbitrary and the value can only meaningfully be used for the ratio of <code class="docutils literal notranslate"><span class="pre">offset</span></code> to <code class="docutils literal notranslate"><span class="pre">len</span></code>. The value is monotonically increasing.</dd> <dt><code class="docutils literal notranslate"><span class="pre">busy</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>false if the job is known to be in a quiescent state, with no pending I/O. Since 1.3.</dd> <dt><code class="docutils literal notranslate"><span class="pre">paused</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether the job is paused or, if <code class="docutils literal notranslate"><span class="pre">busy</span></code> is true, will pause itself as soon as possible. Since 1.3.</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the rate limit, bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">io-status</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDeviceIoStatus</span></code></dt> <dd>the status of the job (since 1.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ready</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the job may be completed (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">JobStatus</span></code></dt> <dd>Current job state/status (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Job will finalize itself when PENDING, moving to the CONCLUDED state. (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Job will dismiss itself when CONCLUDED, moving to the NULL state and disappearing from the query list. (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Error information if the job did not complete successfully. Not set if the job completed successfully. (since 2.12.1)</dd> </dl> </div> <div class="section" id="qapidoc-427"> <h5>Since<a class="headerlink" href="#qapidoc-427" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-431"> <h4><code class="docutils literal notranslate"><span class="pre">query-block-jobs</span></code> (Command)<a class="headerlink" href="#qapidoc-431" title="Permalink to this headline">¶</a></h4> <p>Return information about long-running block device operations.</p> <div class="section" id="qapidoc-429"> <h5>Returns<a class="headerlink" href="#qapidoc-429" title="Permalink to this headline">¶</a></h5> <p>a list of <code class="docutils literal notranslate"><span class="pre">BlockJobInfo</span></code> for each active block job</p> </div> <div class="section" id="qapidoc-430"> <h5>Since<a class="headerlink" href="#qapidoc-430" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-436"> <h4><code class="docutils literal notranslate"><span class="pre">block_resize</span></code> (Command)<a class="headerlink" href="#qapidoc-436" title="Permalink to this headline">¶</a></h4> <p>Resize a block image while a guest is running.</p> <p>Either <code class="docutils literal notranslate"><span class="pre">device</span></code> or <code class="docutils literal notranslate"><span class="pre">node-name</span></code> must be set but not both.</p> <div class="section" id="qapidoc-432"> <h5>Arguments<a class="headerlink" href="#qapidoc-432" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the device to get the image resized</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>graph node name to get the image resized (Since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>new image size in bytes</dd> </dl> </div> <div class="section" id="qapidoc-433"> <h5>Returns<a class="headerlink" href="#qapidoc-433" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-434"> <h5>Since<a class="headerlink" href="#qapidoc-434" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-435"> <h5>Example<a class="headerlink" href="#qapidoc-435" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block_resize"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"scratch"</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">1073741824</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-439"> <h4><code class="docutils literal notranslate"><span class="pre">NewImageMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-439" title="Permalink to this headline">¶</a></h4> <p>An enumeration that tells QEMU how to set the backing file path in a new image file.</p> <div class="section" id="qapidoc-437"> <h5>Values<a class="headerlink" href="#qapidoc-437" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">existing</span></code></dt> <dd>QEMU should look for an existing image file.</dd> <dt><code class="docutils literal notranslate"><span class="pre">absolute-paths</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-438"> <h5>Since<a class="headerlink" href="#qapidoc-438" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-441"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSync</span></code> (Object)<a class="headerlink" href="#qapidoc-441" title="Permalink to this headline">¶</a></h4> <p>Either <code class="docutils literal notranslate"><span class="pre">device</span></code> or <code class="docutils literal notranslate"><span class="pre">node-name</span></code> must be set but not both.</p> <div class="section" id="qapidoc-440"> <h5>Members<a class="headerlink" href="#qapidoc-440" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the device to take a snapshot of.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>graph node name to generate the snapshot from (Since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the graph node name of the new image (Since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the format of the overlay image, default is ‘qcow2’.</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">NewImageMode</span></code> (optional)</dt> <dd>whether and how QEMU should create a new image, default is ‘absolute-paths’.</dd> </dl> </div> </div> <div class="section" id="qapidoc-444"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshot</span></code> (Object)<a class="headerlink" href="#qapidoc-444" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-442"> <h5>Members<a class="headerlink" href="#qapidoc-442" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device or node name that will have a snapshot taken.</dd> <dt><code class="docutils literal notranslate"><span class="pre">overlay</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>reference to the existing block device that will become the overlay of <code class="docutils literal notranslate"><span class="pre">node</span></code>, 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).</dd> </dl> </div> <div class="section" id="qapidoc-443"> <h5>Since<a class="headerlink" href="#qapidoc-443" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-447"> <h4><code class="docutils literal notranslate"><span class="pre">BackupPerf</span></code> (Object)<a class="headerlink" href="#qapidoc-447" title="Permalink to this headline">¶</a></h4> <p>Optional parameters for backup. These parameters don’t affect functionality, but may significantly affect performance.</p> <div class="section" id="qapidoc-445"> <h5>Members<a class="headerlink" href="#qapidoc-445" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">use-copy-range</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Use copy offloading. Default false.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-workers</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Maximum number of parallel requests for the sustained background copying process. Doesn’t influence copy-before-write operations. Default 64.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-chunk</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-446"> <h5>Since<a class="headerlink" href="#qapidoc-446" title="Permalink to this headline">¶</a></h5> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-452"> <h4><code class="docutils literal notranslate"><span class="pre">BackupCommon</span></code> (Object)<a class="headerlink" href="#qapidoc-452" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-448"> <h5>Members<a class="headerlink" href="#qapidoc-448" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of a root node which should be copied.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sync</span></code>: <code class="docutils literal notranslate"><span class="pre">MirrorSyncMode</span></code></dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum speed, in bytes per second. The default is 0, for unlimited.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmap</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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))</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmap-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">BitmapSyncMode</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true to compress data, if the target format supports it. (default: false) (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-source-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-target-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>the action to take on an error on the target, default ‘report’ (no limitations, since this applies to a different block device than <code class="docutils literal notranslate"><span class="pre">device</span></code>).</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a PENDING state after it has finished its work, waiting for <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits <code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code>. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name that should be assigned to the filter driver that the backup job inserts into the graph above node specified by <code class="docutils literal notranslate"><span class="pre">drive</span></code>. If this option is not given, a node name is autogenerated. (Since: 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-perf</span></code>: <code class="docutils literal notranslate"><span class="pre">BackupPerf</span></code> (optional)</dt> <dd>Performance options. (Since 6.0)</dd> </dl> </div> <div class="section" id="qapidoc-449"> <h5>Features<a class="headerlink" href="#qapidoc-449" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-perf</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-450"> <h5>Note<a class="headerlink" href="#qapidoc-450" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">on-source-error</span></code> and <code class="docutils literal notranslate"><span class="pre">on-target-error</span></code> only affect background I/O. If an error occurs during a guest write request, the device’s rerror/werror actions will be used.</p> </div> <div class="section" id="qapidoc-451"> <h5>Since<a class="headerlink" href="#qapidoc-451" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-455"> <h4><code class="docutils literal notranslate"><span class="pre">DriveBackup</span></code> (Object)<a class="headerlink" href="#qapidoc-455" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-453"> <h5>Members<a class="headerlink" href="#qapidoc-453" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the format of the new destination, default is to probe if <code class="docutils literal notranslate"><span class="pre">mode</span></code> is ‘existing’, else the format of the source</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">NewImageMode</span></code> (optional)</dt> <dd>whether and how QEMU should create a new image, default is ‘absolute-paths’.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BackupCommon</span></code></dl> </div> <div class="section" id="qapidoc-454"> <h5>Since<a class="headerlink" href="#qapidoc-454" title="Permalink to this headline">¶</a></h5> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-458"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevBackup</span></code> (Object)<a class="headerlink" href="#qapidoc-458" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-456"> <h5>Members<a class="headerlink" href="#qapidoc-456" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of the backup target node.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BackupCommon</span></code></dl> </div> <div class="section" id="qapidoc-457"> <h5>Since<a class="headerlink" href="#qapidoc-457" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-462"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot-sync</span></code> (Command)<a class="headerlink" href="#qapidoc-462" title="Permalink to this headline">¶</a></h4> <p>Takes a synchronous snapshot of a block device.</p> <p>For the arguments, see the documentation of BlockdevSnapshotSync.</p> <div class="section" id="qapidoc-459"> <h5>Returns<a class="headerlink" href="#qapidoc-459" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-460"> <h5>Since<a class="headerlink" href="#qapidoc-460" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-461"> <h5>Example<a class="headerlink" href="#qapidoc-461" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-sync"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"snapshot-file"</span><span class="p">:</span> <span class="s2">"/some/place/my-image"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-466"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot</span></code> (Command)<a class="headerlink" href="#qapidoc-466" title="Permalink to this headline">¶</a></h4> <p>Takes a snapshot of a block device.</p> <p>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.</p> <p>For the arguments, see the documentation of BlockdevSnapshot.</p> <div class="section" id="qapidoc-463"> <h5>Features<a class="headerlink" href="#qapidoc-463" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">allow-write-only-overlay</span></code></dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-464"> <h5>Since<a class="headerlink" href="#qapidoc-464" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> <div class="section" id="qapidoc-465"> <h5>Example<a class="headerlink" href="#qapidoc-465" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node1534"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"hd1.qcow2"</span> <span class="p">},</span> <span class="s2">"backing"</span><span class="p">:</span> <span class="n">null</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"overlay"</span><span class="p">:</span> <span class="s2">"node1534"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-470"> <h4><code class="docutils literal notranslate"><span class="pre">change-backing-file</span></code> (Command)<a class="headerlink" href="#qapidoc-470" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-467"> <h5>Arguments<a class="headerlink" href="#qapidoc-467" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">image-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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”.</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The device name or node-name of the root node that owns image-node-name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-468"> <h5>Returns<a class="headerlink" href="#qapidoc-468" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If “device” does not exist or cannot be determined, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-469"> <h5>Since<a class="headerlink" href="#qapidoc-469" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-476"> <h4><code class="docutils literal notranslate"><span class="pre">block-commit</span></code> (Command)<a class="headerlink" href="#qapidoc-476" title="Permalink to this headline">¶</a></h4> <p>Live commit of data from overlay image nodes into backing nodes - i.e., writes data between ‘top’ and ‘base’ into ‘base’.</p> <p>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)</p> <p>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.</p> <div class="section" id="qapidoc-471"> <h5>Arguments<a class="headerlink" href="#qapidoc-471" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of a root node</dd> <dt><code class="docutils literal notranslate"><span class="pre">base-node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The node name of the backing image to write data into. If not specified, this is the deepest backing image. (since: 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">base</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Same as <code class="docutils literal notranslate"><span class="pre">base-node</span></code>, 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</dd> <dt><code class="docutils literal notranslate"><span class="pre">top-node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">top</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Same as <code class="docutils literal notranslate"><span class="pre">top-node</span></code>, 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</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd><p class="first">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.</p> <p>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.</p> <p class="last">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)</p> </dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum speed, in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>the action to take on an error. ‘ignore’ means that the request should be retried. (default: report; Since: 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name that should be assigned to the filter driver that the commit job inserts into the graph above <code class="docutils literal notranslate"><span class="pre">top</span></code>. If this option is not given, a node name is autogenerated. (Since: 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a PENDING state after it has finished its work, waiting for <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits <code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code>. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-472"> <h5>Features<a class="headerlink" href="#qapidoc-472" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Members <code class="docutils literal notranslate"><span class="pre">base</span></code> and <code class="docutils literal notranslate"><span class="pre">top</span></code> are deprecated. Use <code class="docutils literal notranslate"><span class="pre">base-node</span></code> and <code class="docutils literal notranslate"><span class="pre">top-node</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-473"> <h5>Returns<a class="headerlink" href="#qapidoc-473" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> does not exist, DeviceNotFound</li> <li>Any other error returns a GenericError.</li> </ul> </div> <div class="section" id="qapidoc-474"> <h5>Since<a class="headerlink" href="#qapidoc-474" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> <div class="section" id="qapidoc-475"> <h5>Example<a class="headerlink" href="#qapidoc-475" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-commit"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"virtio0"</span><span class="p">,</span> <span class="s2">"top"</span><span class="p">:</span> <span class="s2">"/tmp/snap1.qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-482"> <h4><code class="docutils literal notranslate"><span class="pre">drive-backup</span></code> (Command)<a class="headerlink" href="#qapidoc-482" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-477"> <h5>Arguments<a class="headerlink" href="#qapidoc-477" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">DriveBackup</span></code></dl> </div> <div class="section" id="qapidoc-478"> <h5>Features<a class="headerlink" href="#qapidoc-478" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>This command is deprecated. Use <code class="docutils literal notranslate"><span class="pre">blockdev-backup</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-479"> <h5>Returns<a class="headerlink" href="#qapidoc-479" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, GenericError</li> </ul> </div> <div class="section" id="qapidoc-480"> <h5>Since<a class="headerlink" href="#qapidoc-480" title="Permalink to this headline">¶</a></h5> <p>1.6</p> </div> <div class="section" id="qapidoc-481"> <h5>Example<a class="headerlink" href="#qapidoc-481" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"drive-backup"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"sync"</span><span class="p">:</span> <span class="s2">"full"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"backup.img"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-487"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-backup</span></code> (Command)<a class="headerlink" href="#qapidoc-487" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-483"> <h5>Arguments<a class="headerlink" href="#qapidoc-483" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevBackup</span></code></dl> </div> <div class="section" id="qapidoc-484"> <h5>Returns<a class="headerlink" href="#qapidoc-484" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-485"> <h5>Since<a class="headerlink" href="#qapidoc-485" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-486"> <h5>Example<a class="headerlink" href="#qapidoc-486" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-backup"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"src-id"</span><span class="p">,</span> <span class="s2">"sync"</span><span class="p">:</span> <span class="s2">"full"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"tgt-id"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-492"> <h4><code class="docutils literal notranslate"><span class="pre">query-named-block-nodes</span></code> (Command)<a class="headerlink" href="#qapidoc-492" title="Permalink to this headline">¶</a></h4> <p>Get the named block driver list</p> <div class="section" id="qapidoc-488"> <h5>Arguments<a class="headerlink" href="#qapidoc-488" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">flat</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Omit the nested data about backing image (“backing-image” key) if true. Default is false (Since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-489"> <h5>Returns<a class="headerlink" href="#qapidoc-489" title="Permalink to this headline">¶</a></h5> <p>the list of BlockDeviceInfo</p> </div> <div class="section" id="qapidoc-490"> <h5>Since<a class="headerlink" href="#qapidoc-490" title="Permalink to this headline">¶</a></h5> <p>2.0</p> </div> <div class="section" id="qapidoc-491"> <h5>Example<a class="headerlink" href="#qapidoc-491" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-named-block-nodes"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"ro"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"drv"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"encrypted"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span><span class="s2">"disks/test.qcow2"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"my-node"</span><span class="p">,</span> <span class="s2">"backing_file_depth"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"bps"</span><span class="p">:</span><span class="mi">1000000</span><span class="p">,</span> <span class="s2">"bps_rd"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"iops"</span><span class="p">:</span><span class="mi">1000000</span><span class="p">,</span> <span class="s2">"iops_rd"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max"</span><span class="p">:</span> <span class="mi">8000000</span><span class="p">,</span> <span class="s2">"bps_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_size"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"write_threshold"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"image"</span><span class="p">:{</span> <span class="s2">"filename"</span><span class="p">:</span><span class="s2">"disks/test.qcow2"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"virtual-size"</span><span class="p">:</span><span class="mi">2048000</span><span class="p">,</span> <span class="s2">"backing_file"</span><span class="p">:</span><span class="s2">"base.qcow2"</span><span class="p">,</span> <span class="s2">"full-backing-filename"</span><span class="p">:</span><span class="s2">"disks/base.qcow2"</span><span class="p">,</span> <span class="s2">"backing-filename-format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"snapshots"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot1"</span><span class="p">,</span> <span class="s2">"vm-state-size"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"date-sec"</span><span class="p">:</span> <span class="mi">10000200</span><span class="p">,</span> <span class="s2">"date-nsec"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> <span class="s2">"vm-clock-sec"</span><span class="p">:</span> <span class="mi">206</span><span class="p">,</span> <span class="s2">"vm-clock-nsec"</span><span class="p">:</span> <span class="mi">30</span> <span class="p">}</span> <span class="p">],</span> <span class="s2">"backing-image"</span><span class="p">:{</span> <span class="s2">"filename"</span><span class="p">:</span><span class="s2">"disks/base.qcow2"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span><span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"virtual-size"</span><span class="p">:</span><span class="mi">2048000</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-495"> <h4><code class="docutils literal notranslate"><span class="pre">XDbgBlockGraphNodeType</span></code> (Enum)<a class="headerlink" href="#qapidoc-495" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-493"> <h5>Values<a class="headerlink" href="#qapidoc-493" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">block-backend</span></code></dt> <dd>corresponds to BlockBackend</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-job</span></code></dt> <dd>corresponds to BlockJob</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-driver</span></code></dt> <dd>corresponds to BlockDriverState</dd> </dl> </div> <div class="section" id="qapidoc-494"> <h5>Since<a class="headerlink" href="#qapidoc-494" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-498"> <h4><code class="docutils literal notranslate"><span class="pre">XDbgBlockGraphNode</span></code> (Object)<a class="headerlink" href="#qapidoc-498" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-496"> <h5>Members<a class="headerlink" href="#qapidoc-496" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Block graph node identifier. This <code class="docutils literal notranslate"><span class="pre">id</span></code> is generated only for x-debug-query-block-graph and does not relate to any other identifiers in Qemu.</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">XDbgBlockGraphNodeType</span></code></dt> <dd>Type of graph node. Can be one of block-backend, block-job or block-driver-state.</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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).</dd> </dl> </div> <div class="section" id="qapidoc-497"> <h5>Since<a class="headerlink" href="#qapidoc-497" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-501"> <h4><code class="docutils literal notranslate"><span class="pre">BlockPermission</span></code> (Enum)<a class="headerlink" href="#qapidoc-501" title="Permalink to this headline">¶</a></h4> <p>Enum of base block permissions.</p> <div class="section" id="qapidoc-499"> <h5>Values<a class="headerlink" href="#qapidoc-499" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">consistent-read</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">write</span></code></dt> <dd>This permission is required to change the visible disk contents.</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-unchanged</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">resize</span></code></dt> <dd>This permission is required to change the size of a block node.</dd> <dt><code class="docutils literal notranslate"><span class="pre">graph-mod</span></code></dt> <dd>This permission is required to change the node that this BdrvChild points to.</dd> </dl> </div> <div class="section" id="qapidoc-500"> <h5>Since<a class="headerlink" href="#qapidoc-500" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-504"> <h4><code class="docutils literal notranslate"><span class="pre">XDbgBlockGraphEdge</span></code> (Object)<a class="headerlink" href="#qapidoc-504" title="Permalink to this headline">¶</a></h4> <p>Block Graph edge description for x-debug-query-block-graph.</p> <div class="section" id="qapidoc-502"> <h5>Members<a class="headerlink" href="#qapidoc-502" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">parent</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>parent id</dd> <dt><code class="docutils literal notranslate"><span class="pre">child</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>child id</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the relation (examples are ‘file’ and ‘backing’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">perm</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockPermission</span></code></dt> <dd>granted permissions for the parent operating on the child</dd> <dt><code class="docutils literal notranslate"><span class="pre">shared-perm</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockPermission</span></code></dt> <dd>permissions that can still be granted to other users of the child while it is still attached to this parent</dd> </dl> </div> <div class="section" id="qapidoc-503"> <h5>Since<a class="headerlink" href="#qapidoc-503" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-507"> <h4><code class="docutils literal notranslate"><span class="pre">XDbgBlockGraph</span></code> (Object)<a class="headerlink" href="#qapidoc-507" title="Permalink to this headline">¶</a></h4> <p>Block Graph - list of nodes and list of edges.</p> <div class="section" id="qapidoc-505"> <h5>Members<a class="headerlink" href="#qapidoc-505" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">nodes</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">XDbgBlockGraphNode</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">edges</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">XDbgBlockGraphEdge</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-506"> <h5>Since<a class="headerlink" href="#qapidoc-506" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-510"> <h4><code class="docutils literal notranslate"><span class="pre">x-debug-query-block-graph</span></code> (Command)<a class="headerlink" href="#qapidoc-510" title="Permalink to this headline">¶</a></h4> <p>Get the block graph.</p> <div class="section" id="qapidoc-508"> <h5>Features<a class="headerlink" href="#qapidoc-508" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-509"> <h5>Since<a class="headerlink" href="#qapidoc-509" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-515"> <h4><code class="docutils literal notranslate"><span class="pre">drive-mirror</span></code> (Command)<a class="headerlink" href="#qapidoc-515" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-511"> <h5>Arguments<a class="headerlink" href="#qapidoc-511" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">DriveMirror</span></code></dl> </div> <div class="section" id="qapidoc-512"> <h5>Returns<a class="headerlink" href="#qapidoc-512" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, GenericError</li> </ul> </div> <div class="section" id="qapidoc-513"> <h5>Since<a class="headerlink" href="#qapidoc-513" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> <div class="section" id="qapidoc-514"> <h5>Example<a class="headerlink" href="#qapidoc-514" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"drive-mirror"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"/some/place/my-image"</span><span class="p">,</span> <span class="s2">"sync"</span><span class="p">:</span> <span class="s2">"full"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-518"> <h4><code class="docutils literal notranslate"><span class="pre">DriveMirror</span></code> (Object)<a class="headerlink" href="#qapidoc-518" title="Permalink to this headline">¶</a></h4> <p>A set of parameters describing drive mirror setup.</p> <div class="section" id="qapidoc-516"> <h5>Members<a class="headerlink" href="#qapidoc-516" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of a root node whose writes should be mirrored.</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the format of the new destination, default is to probe if <code class="docutils literal notranslate"><span class="pre">mode</span></code> is ‘existing’, else the format of the source</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the new block driver state node name in the graph (Since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">replaces</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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, <code class="docutils literal notranslate"><span class="pre">device</span></code> is replaced, although implicitly created filters on it are kept. (Since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">NewImageMode</span></code> (optional)</dt> <dd>whether and how QEMU should create a new image, default is ‘absolute-paths’.</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum speed, in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">sync</span></code>: <code class="docutils literal notranslate"><span class="pre">MirrorSyncMode</span></code></dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">granularity</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">buf-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum amount of data in flight from source to target (since 1.4).</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-source-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-target-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>the action to take on an error on the target, default ‘report’ (no limitations, since this applies to a different block device than <code class="docutils literal notranslate"><span class="pre">device</span></code>).</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">copy-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">MirrorCopyMode</span></code> (optional)</dt> <dd>when to copy data to the destination; defaults to ‘background’ (Since: 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a PENDING state after it has finished its work, waiting for <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits <code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code>. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-517"> <h5>Since<a class="headerlink" href="#qapidoc-517" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-521"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmap</span></code> (Object)<a class="headerlink" href="#qapidoc-521" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-519"> <h5>Members<a class="headerlink" href="#qapidoc-519" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of device/node which the bitmap is tracking</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the dirty bitmap</dd> </dl> </div> <div class="section" id="qapidoc-520"> <h5>Since<a class="headerlink" href="#qapidoc-520" title="Permalink to this headline">¶</a></h5> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-524"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAdd</span></code> (Object)<a class="headerlink" href="#qapidoc-524" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-522"> <h5>Members<a class="headerlink" href="#qapidoc-522" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of device/node which the bitmap is tracking</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the dirty bitmap (must be less than 1024 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">granularity</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the bitmap granularity, default is 64k for block-dirty-bitmap-add</dd> <dt><code class="docutils literal notranslate"><span class="pre">persistent</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">disabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-523"> <h5>Since<a class="headerlink" href="#qapidoc-523" title="Permalink to this headline">¶</a></h5> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-527"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMergeSource</span></code> (Alternate)<a class="headerlink" href="#qapidoc-527" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-525"> <h5>Members<a class="headerlink" href="#qapidoc-525" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">local</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the bitmap, attached to the same node as target bitmap.</dd> <dt><code class="docutils literal notranslate"><span class="pre">external</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmap</span></code></dt> <dd>bitmap with specified node</dd> </dl> </div> <div class="section" id="qapidoc-526"> <h5>Since<a class="headerlink" href="#qapidoc-526" title="Permalink to this headline">¶</a></h5> <p>4.1</p> </div> </div> <div class="section" id="qapidoc-530"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMerge</span></code> (Object)<a class="headerlink" href="#qapidoc-530" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-528"> <h5>Members<a class="headerlink" href="#qapidoc-528" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of device/node which the <code class="docutils literal notranslate"><span class="pre">target</span></code> bitmap is tracking</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the destination dirty bitmap</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockDirtyBitmapMergeSource</span></code></dt> <dd>name(s) of the source dirty bitmap(s) at <code class="docutils literal notranslate"><span class="pre">node</span></code> and/or fully specified BlockDirtyBitmap elements. The latter are supported since 4.1.</dd> </dl> </div> <div class="section" id="qapidoc-529"> <h5>Since<a class="headerlink" href="#qapidoc-529" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-534"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-add</span></code> (Command)<a class="headerlink" href="#qapidoc-534" title="Permalink to this headline">¶</a></h4> <p>Create a dirty bitmap with a name on the node, and start tracking the writes.</p> <div class="section" id="qapidoc-531"> <h5>Returns<a class="headerlink" href="#qapidoc-531" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device or node, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is already taken, GenericError with an explanation</li> </ul> </div> <div class="section" id="qapidoc-532"> <h5>Since<a class="headerlink" href="#qapidoc-532" title="Permalink to this headline">¶</a></h5> <p>2.4</p> </div> <div class="section" id="qapidoc-533"> <h5>Example<a class="headerlink" href="#qapidoc-533" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitmap0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-538"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-remove</span></code> (Command)<a class="headerlink" href="#qapidoc-538" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-535"> <h5>Returns<a class="headerlink" href="#qapidoc-535" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device or node, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not found, GenericError with an explanation</li> <li>if <code class="docutils literal notranslate"><span class="pre">name</span></code> is frozen by an operation, GenericError</li> </ul> </div> <div class="section" id="qapidoc-536"> <h5>Since<a class="headerlink" href="#qapidoc-536" title="Permalink to this headline">¶</a></h5> <p>2.4</p> </div> <div class="section" id="qapidoc-537"> <h5>Example<a class="headerlink" href="#qapidoc-537" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-remove"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitmap0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-542"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-clear</span></code> (Command)<a class="headerlink" href="#qapidoc-542" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-539"> <h5>Returns<a class="headerlink" href="#qapidoc-539" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not found, GenericError with an explanation</li> </ul> </div> <div class="section" id="qapidoc-540"> <h5>Since<a class="headerlink" href="#qapidoc-540" title="Permalink to this headline">¶</a></h5> <p>2.4</p> </div> <div class="section" id="qapidoc-541"> <h5>Example<a class="headerlink" href="#qapidoc-541" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-clear"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitmap0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-546"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-enable</span></code> (Command)<a class="headerlink" href="#qapidoc-546" title="Permalink to this headline">¶</a></h4> <p>Enables a dirty bitmap so that it will begin tracking disk changes.</p> <div class="section" id="qapidoc-543"> <h5>Returns<a class="headerlink" href="#qapidoc-543" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not found, GenericError with an explanation</li> </ul> </div> <div class="section" id="qapidoc-544"> <h5>Since<a class="headerlink" href="#qapidoc-544" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> <div class="section" id="qapidoc-545"> <h5>Example<a class="headerlink" href="#qapidoc-545" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-enable"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitmap0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-550"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-disable</span></code> (Command)<a class="headerlink" href="#qapidoc-550" title="Permalink to this headline">¶</a></h4> <p>Disables a dirty bitmap so that it will stop tracking disk changes.</p> <div class="section" id="qapidoc-547"> <h5>Returns<a class="headerlink" href="#qapidoc-547" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not found, GenericError with an explanation</li> </ul> </div> <div class="section" id="qapidoc-548"> <h5>Since<a class="headerlink" href="#qapidoc-548" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> <div class="section" id="qapidoc-549"> <h5>Example<a class="headerlink" href="#qapidoc-549" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-disable"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bitmap0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-554"> <h4><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-merge</span></code> (Command)<a class="headerlink" href="#qapidoc-554" title="Permalink to this headline">¶</a></h4> <p>Merge dirty bitmaps listed in <code class="docutils literal notranslate"><span class="pre">bitmaps</span></code> to the <code class="docutils literal notranslate"><span class="pre">target</span></code> dirty bitmap. Dirty bitmaps in <code class="docutils literal notranslate"><span class="pre">bitmaps</span></code> will be unchanged, except if it also appears as the <code class="docutils literal notranslate"><span class="pre">target</span></code> bitmap. Any bits already set in <code class="docutils literal notranslate"><span class="pre">target</span></code> will still be set after the merge, i.e., this operation does not clear the target. On error, <code class="docutils literal notranslate"><span class="pre">target</span></code> is unchanged.</p> <p>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.</p> <div class="section" id="qapidoc-551"> <h5>Returns<a class="headerlink" href="#qapidoc-551" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device, DeviceNotFound</li> <li>If any bitmap in <code class="docutils literal notranslate"><span class="pre">bitmaps</span></code> or <code class="docutils literal notranslate"><span class="pre">target</span></code> is not found, GenericError</li> <li>If any of the bitmaps have different sizes or granularities, GenericError</li> </ul> </div> <div class="section" id="qapidoc-552"> <h5>Since<a class="headerlink" href="#qapidoc-552" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> <div class="section" id="qapidoc-553"> <h5>Example<a class="headerlink" href="#qapidoc-553" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-dirty-bitmap-merge"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"bitmap0"</span><span class="p">,</span> <span class="s2">"bitmaps"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"bitmap1"</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-557"> <h4><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapSha256</span></code> (Object)<a class="headerlink" href="#qapidoc-557" title="Permalink to this headline">¶</a></h4> <p>SHA256 hash of dirty bitmap data</p> <div class="section" id="qapidoc-555"> <h5>Members<a class="headerlink" href="#qapidoc-555" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sha256</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>ASCII representation of SHA256 bitmap hash</dd> </dl> </div> <div class="section" id="qapidoc-556"> <h5>Since<a class="headerlink" href="#qapidoc-556" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-561"> <h4><code class="docutils literal notranslate"><span class="pre">x-debug-block-dirty-bitmap-sha256</span></code> (Command)<a class="headerlink" href="#qapidoc-561" title="Permalink to this headline">¶</a></h4> <p>Get bitmap SHA256.</p> <div class="section" id="qapidoc-558"> <h5>Features<a class="headerlink" href="#qapidoc-558" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-559"> <h5>Returns<a class="headerlink" href="#qapidoc-559" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>BlockDirtyBitmapSha256 on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is not a valid block device, DeviceNotFound</li> <li>If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not found or if hashing has failed, GenericError with an explanation</li> </ul> </div> <div class="section" id="qapidoc-560"> <h5>Since<a class="headerlink" href="#qapidoc-560" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-566"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-mirror</span></code> (Command)<a class="headerlink" href="#qapidoc-566" title="Permalink to this headline">¶</a></h4> <p>Start mirroring a block device’s writes to a new destination.</p> <div class="section" id="qapidoc-562"> <h5>Arguments<a class="headerlink" href="#qapidoc-562" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The device name or node-name of a root node whose writes should be mirrored.</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the id or node-name of the block device to mirror to. This mustn’t be attached to guest.</dd> <dt><code class="docutils literal notranslate"><span class="pre">replaces</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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, <code class="docutils literal notranslate"><span class="pre">device</span></code> is replaced, although implicitly created filters on it are kept.</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum speed, in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">sync</span></code>: <code class="docutils literal notranslate"><span class="pre">MirrorSyncMode</span></code></dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">granularity</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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</dd> <dt><code class="docutils literal notranslate"><span class="pre">buf-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum amount of data in flight from source to target</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-source-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>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).</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-target-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>the action to take on an error on the target, default ‘report’ (no limitations, since this applies to a different block device than <code class="docutils literal notranslate"><span class="pre">device</span></code>).</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name that should be assigned to the filter driver that the mirror job inserts into the graph above <code class="docutils literal notranslate"><span class="pre">device</span></code>. If this option is not given, a node name is autogenerated. (Since: 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">copy-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">MirrorCopyMode</span></code> (optional)</dt> <dd>when to copy data to the destination; defaults to ‘background’ (Since: 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a PENDING state after it has finished its work, waiting for <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits <code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code>. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-563"> <h5>Returns<a class="headerlink" href="#qapidoc-563" title="Permalink to this headline">¶</a></h5> <p>nothing on success.</p> </div> <div class="section" id="qapidoc-564"> <h5>Since<a class="headerlink" href="#qapidoc-564" title="Permalink to this headline">¶</a></h5> <p>2.6</p> </div> <div class="section" id="qapidoc-565"> <h5>Example<a class="headerlink" href="#qapidoc-565" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-mirror"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span> <span class="s2">"target0"</span><span class="p">,</span> <span class="s2">"sync"</span><span class="p">:</span> <span class="s2">"full"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-570"> <h4><code class="docutils literal notranslate"><span class="pre">BlockIOThrottle</span></code> (Object)<a class="headerlink" href="#qapidoc-570" title="Permalink to this headline">¶</a></h4> <p>A set of parameters describing block throttling.</p> <div class="section" id="qapidoc-567"> <h5>Members<a class="headerlink" href="#qapidoc-567" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Block device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name or QOM path of the guest device (since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total throughput limit in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>read throughput limit in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>write throughput limit in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total I/O operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>read I/O operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>write I/O operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total throughput limit during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>read throughput limit during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>write throughput limit during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total I/O operations per second during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>read I/O operations per second during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr_max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>write I/O operations per second during bursts, in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_max</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">bps_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_rd_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_rd_max</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">bps_rd_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps_wr_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">bps_wr_max</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">bps_wr_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">iops_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_rd_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops_rd_max</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">iops_rd_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_wr_max_length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum length of the <code class="docutils literal notranslate"><span class="pre">iops_wr_max</span></code> burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">iops_wr_max</span></code> is set as well. Defaults to 1. (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops_size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>an I/O size in bytes (Since 1.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">group</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>throttle group name (Since 2.4)</dd> </dl> </div> <div class="section" id="qapidoc-568"> <h5>Features<a class="headerlink" href="#qapidoc-568" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">device</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">id</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-569"> <h5>Since<a class="headerlink" href="#qapidoc-569" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-573"> <h4><code class="docutils literal notranslate"><span class="pre">ThrottleLimits</span></code> (Object)<a class="headerlink" href="#qapidoc-573" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-571"> <h5>Members<a class="headerlink" href="#qapidoc-571" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">iops-total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit total I/O operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-total-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>I/O operations burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-total-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the iops-total-max burst period, in seconds It must only be set if <code class="docutils literal notranslate"><span class="pre">iops-total-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-read</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit read operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-read-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>I/O operations read burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-read-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the iops-read-max burst period, in seconds It must only be set if <code class="docutils literal notranslate"><span class="pre">iops-read-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-write</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit write operations per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-write-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>I/O operations write burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-write-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the iops-write-max burst period, in seconds It must only be set if <code class="docutils literal notranslate"><span class="pre">iops-write-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit total bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-total-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total bytes burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-total-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the bps-total-max burst period, in seconds. It must only be set if <code class="docutils literal notranslate"><span class="pre">bps-total-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-read</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit read bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-read-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total bytes read burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-read-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the bps-read-max burst period, in seconds It must only be set if <code class="docutils literal notranslate"><span class="pre">bps-read-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-write</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>limit write bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-write-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total bytes write burst</dd> <dt><code class="docutils literal notranslate"><span class="pre">bps-write-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>length of the bps-write-max burst period, in seconds It must only be set if <code class="docutils literal notranslate"><span class="pre">bps-write-max</span></code> is set as well.</dd> <dt><code class="docutils literal notranslate"><span class="pre">iops-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>when limiting by iops max size of an I/O in bytes</dd> </dl> </div> <div class="section" id="qapidoc-572"> <h5>Since<a class="headerlink" href="#qapidoc-572" title="Permalink to this headline">¶</a></h5> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-577"> <h4><code class="docutils literal notranslate"><span class="pre">ThrottleGroupProperties</span></code> (Object)<a class="headerlink" href="#qapidoc-577" title="Permalink to this headline">¶</a></h4> <p>Properties for throttle-group objects.</p> <div class="section" id="qapidoc-574"> <h5>Members<a class="headerlink" href="#qapidoc-574" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">limits</span></code>: <code class="docutils literal notranslate"><span class="pre">ThrottleLimits</span></code> (optional)</dt> <dd>limits to apply for this throttle group</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-total-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-total-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-read</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-read-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-read-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-write</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-write-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-write-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-total-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-total-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-read</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-read-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-read-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-write</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-write-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-bps-write-max-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-iops-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-575"> <h5>Features<a class="headerlink" href="#qapidoc-575" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>All members starting with x- are aliases for the same key without x- in the <code class="docutils literal notranslate"><span class="pre">limits</span></code> object. This is not a stable interface and may be removed or changed incompatibly in the future. Use <code class="docutils literal notranslate"><span class="pre">limits</span></code> for a supported stable interface.</dd> </dl> </div> <div class="section" id="qapidoc-576"> <h5>Since<a class="headerlink" href="#qapidoc-576" title="Permalink to this headline">¶</a></h5> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-582"> <h4><code class="docutils literal notranslate"><span class="pre">block-stream</span></code> (Command)<a class="headerlink" href="#qapidoc-582" title="Permalink to this headline">¶</a></h4> <p>Copy data from a backing file into a block device.</p> <p>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.</p> <p>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’.</p> <p>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.</p> <p>On successful completion the image file is updated to drop the backing file and the BLOCK_JOB_COMPLETED event is emitted.</p> <p>In case <code class="docutils literal notranslate"><span class="pre">device</span></code> 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 <code class="docutils literal notranslate"><span class="pre">device</span></code> itself.</p> <div class="section" id="qapidoc-578"> <h5>Arguments<a class="headerlink" href="#qapidoc-578" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier for the newly-created block job. If omitted, the device name will be used. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device or node name of the top image</dd> <dt><code class="docutils literal notranslate"><span class="pre">base</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the common backing file name. It cannot be set if <code class="docutils literal notranslate"><span class="pre">base-node</span></code> or <code class="docutils literal notranslate"><span class="pre">bottom</span></code> is also set.</dd> <dt><code class="docutils literal notranslate"><span class="pre">base-node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name of the backing file. It cannot be set if <code class="docutils literal notranslate"><span class="pre">base</span></code> or <code class="docutils literal notranslate"><span class="pre">bottom</span></code> is also set. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">bottom</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the last node in the chain that should be streamed into top. It cannot be set if <code class="docutils literal notranslate"><span class="pre">base</span></code> or <code class="docutils literal notranslate"><span class="pre">base-node</span></code> is also set. It cannot be filter node. (Since 6.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd><p class="first">The backing file string to write into the top image. This filename is not validated.</p> <p>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.</p> <p class="last">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)</p> </dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum speed, in bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">on-error</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOnError</span></code> (optional)</dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name that should be assigned to the filter driver that the stream job inserts into the graph above <code class="docutils literal notranslate"><span class="pre">device</span></code>. If this option is not given, a node name is autogenerated. (Since: 6.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-finalize</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a PENDING state after it has finished its work, waiting for <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> before making any block graph changes. When true, this job will automatically perform its abort or commit actions. Defaults to true. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-dismiss</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>When false, this job will wait in a CONCLUDED state after it has completely ceased all work, and awaits <code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code>. When true, this job will automatically disappear from the query list without user intervention. Defaults to true. (Since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-579"> <h5>Returns<a class="headerlink" href="#qapidoc-579" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success.</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> does not exist, DeviceNotFound.</li> </ul> </div> <div class="section" id="qapidoc-580"> <h5>Since<a class="headerlink" href="#qapidoc-580" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-581"> <h5>Example<a class="headerlink" href="#qapidoc-581" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-stream"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"virtio0"</span><span class="p">,</span> <span class="s2">"base"</span><span class="p">:</span> <span class="s2">"/tmp/master.qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-586"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-set-speed</span></code> (Command)<a class="headerlink" href="#qapidoc-586" title="Permalink to this headline">¶</a></h4> <p>Set maximum speed for a background block operation.</p> <p>This command can only be issued when there is an active block job.</p> <p>Throttling can be disabled by setting the speed to 0.</p> <div class="section" id="qapidoc-583"> <h5>Arguments<a class="headerlink" href="#qapidoc-583" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the maximum speed, in bytes per second, or 0 for unlimited. Defaults to 0.</dd> </dl> </div> <div class="section" id="qapidoc-584"> <h5>Returns<a class="headerlink" href="#qapidoc-584" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If no background operation is active on this device, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-585"> <h5>Since<a class="headerlink" href="#qapidoc-585" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-590"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-cancel</span></code> (Command)<a class="headerlink" href="#qapidoc-590" title="Permalink to this headline">¶</a></h4> <p>Stop an active background block operation.</p> <p>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.</p> <p>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.</p> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-587"> <h5>Arguments<a class="headerlink" href="#qapidoc-587" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">force</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-588"> <h5>Returns<a class="headerlink" href="#qapidoc-588" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If no background operation is active on this device, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-589"> <h5>Since<a class="headerlink" href="#qapidoc-589" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-594"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-pause</span></code> (Command)<a class="headerlink" href="#qapidoc-594" title="Permalink to this headline">¶</a></h4> <p>Pause an active background block operation.</p> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-591"> <h5>Arguments<a class="headerlink" href="#qapidoc-591" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-592"> <h5>Returns<a class="headerlink" href="#qapidoc-592" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If no background operation is active on this device, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-593"> <h5>Since<a class="headerlink" href="#qapidoc-593" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-598"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-resume</span></code> (Command)<a class="headerlink" href="#qapidoc-598" title="Permalink to this headline">¶</a></h4> <p>Resume an active background block operation.</p> <p>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.</p> <p>This command also clears the error status of the job.</p> <div class="section" id="qapidoc-595"> <h5>Arguments<a class="headerlink" href="#qapidoc-595" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-596"> <h5>Returns<a class="headerlink" href="#qapidoc-596" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If no background operation is active on this device, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-597"> <h5>Since<a class="headerlink" href="#qapidoc-597" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-602"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-complete</span></code> (Command)<a class="headerlink" href="#qapidoc-602" title="Permalink to this headline">¶</a></h4> <p>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.</p> <p>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.</p> <p>A cancelled or paused job cannot be completed.</p> <div class="section" id="qapidoc-599"> <h5>Arguments<a class="headerlink" href="#qapidoc-599" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>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.</dd> </dl> </div> <div class="section" id="qapidoc-600"> <h5>Returns<a class="headerlink" href="#qapidoc-600" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If no background operation is active on this device, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-601"> <h5>Since<a class="headerlink" href="#qapidoc-601" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-606"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-dismiss</span></code> (Command)<a class="headerlink" href="#qapidoc-606" title="Permalink to this headline">¶</a></h4> <p>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.</p> <p>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.</p> <div class="section" id="qapidoc-603"> <h5>Arguments<a class="headerlink" href="#qapidoc-603" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-604"> <h5>Returns<a class="headerlink" href="#qapidoc-604" title="Permalink to this headline">¶</a></h5> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-605"> <h5>Since<a class="headerlink" href="#qapidoc-605" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-610"> <h4><code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code> (Command)<a class="headerlink" href="#qapidoc-610" title="Permalink to this headline">¶</a></h4> <p>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.</p> <div class="section" id="qapidoc-607"> <h5>Arguments<a class="headerlink" href="#qapidoc-607" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-608"> <h5>Returns<a class="headerlink" href="#qapidoc-608" title="Permalink to this headline">¶</a></h5> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-609"> <h5>Since<a class="headerlink" href="#qapidoc-609" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-613"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevDiscardOptions</span></code> (Enum)<a class="headerlink" href="#qapidoc-613" title="Permalink to this headline">¶</a></h4> <p>Determines how to handle discard requests.</p> <div class="section" id="qapidoc-611"> <h5>Values<a class="headerlink" href="#qapidoc-611" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ignore</span></code></dt> <dd>Ignore the request</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap</span></code></dt> <dd>Forward as an unmap request</dd> </dl> </div> <div class="section" id="qapidoc-612"> <h5>Since<a class="headerlink" href="#qapidoc-612" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-616"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevDetectZeroesOptions</span></code> (Enum)<a class="headerlink" href="#qapidoc-616" title="Permalink to this headline">¶</a></h4> <p>Describes the operation mode for the automatic conversion of plain zero writes by the OS to driver specific optimized zero write commands.</p> <div class="section" id="qapidoc-614"> <h5>Values<a class="headerlink" href="#qapidoc-614" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>Disabled (default)</dd> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>Enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">unmap</span></code></dt> <dd>Enabled and even try to unmap blocks if possible. This requires also that <code class="docutils literal notranslate"><span class="pre">BlockdevDiscardOptions</span></code> is set to unmap for this device.</dd> </dl> </div> <div class="section" id="qapidoc-615"> <h5>Since<a class="headerlink" href="#qapidoc-615" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-619"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevAioOptions</span></code> (Enum)<a class="headerlink" href="#qapidoc-619" title="Permalink to this headline">¶</a></h4> <p>Selects the AIO backend to handle I/O requests</p> <div class="section" id="qapidoc-617"> <h5>Values<a class="headerlink" href="#qapidoc-617" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">threads</span></code></dt> <dd>Use qemu’s thread pool</dd> <dt><code class="docutils literal notranslate"><span class="pre">native</span></code></dt> <dd>Use native AIO backend (only Linux and Windows)</dd> <dt><code class="docutils literal notranslate"><span class="pre">io_uring</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX_IO_URING</span></code>)</dt> <dd>Use linux io_uring (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-618"> <h5>Since<a class="headerlink" href="#qapidoc-618" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-622"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCacheOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-622" title="Permalink to this headline">¶</a></h4> <p>Includes cache-related options for block devices</p> <div class="section" id="qapidoc-620"> <h5>Members<a class="headerlink" href="#qapidoc-620" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">direct</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enables use of O_DIRECT (bypass the host page cache; default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">no-flush</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>ignore any flush requests for the device (default: false)</dd> </dl> </div> <div class="section" id="qapidoc-621"> <h5>Since<a class="headerlink" href="#qapidoc-621" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-625"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code> (Enum)<a class="headerlink" href="#qapidoc-625" title="Permalink to this headline">¶</a></h4> <p>Drivers that are supported in block device operations.</p> <div class="section" id="qapidoc-623"> <h5>Values<a class="headerlink" href="#qapidoc-623" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">throttle</span></code></dt> <dd>Since 2.11</dd> <dt><code class="docutils literal notranslate"><span class="pre">nvme</span></code></dt> <dd>Since 2.12</dd> <dt><code class="docutils literal notranslate"><span class="pre">copy-on-read</span></code></dt> <dd>Since 3.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">blklogwrites</span></code></dt> <dd>Since 3.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">blkreplay</span></code></dt> <dd>Since 4.2</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress</span></code></dt> <dd>Since 5.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">copy-before-write</span></code></dt> <dd>Since 6.2</dd> <dt><code class="docutils literal notranslate"><span class="pre">blkdebug</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">blkverify</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">bochs</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cloop</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">dmg</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ftp</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ftps</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">gluster</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">host_cdrom</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_HOST_BLOCK_DEVICE</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">host_device</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_HOST_BLOCK_DEVICE</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">http</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">https</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">iscsi</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">luks</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">nbd</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">nfs</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">null-aio</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">null-co</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">parallels</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocate</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">qcow</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">qcow2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">qed</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">quorum</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">raw</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">rbd</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">replication</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ssh</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vdi</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhdx</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmdk</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vpc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vvfat</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-624"> <h5>Since<a class="headerlink" href="#qapidoc-624" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-629"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsFile</span></code> (Object)<a class="headerlink" href="#qapidoc-629" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the file backend.</p> <div class="section" id="qapidoc-626"> <h5>Members<a class="headerlink" href="#qapidoc-626" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>path to the image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">pr-manager</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the id for the object that will handle persistent reservations for this device (default: none, forward the commands via SG_IO; since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">aio</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevAioOptions</span></code> (optional)</dt> <dd>AIO backend (default: threads) (since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">aio-max-batch</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">locking</span></code>: <code class="docutils literal notranslate"><span class="pre">OnOffAuto</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">drop-cache</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional) (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-check-cache-dropped</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>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)</dd> </dl> </div> <div class="section" id="qapidoc-627"> <h5>Features<a class="headerlink" href="#qapidoc-627" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dynamic-auto-read-only</span></code></dt> <dd>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.</dd> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member x-check-cache-dropped is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-628"> <h5>Since<a class="headerlink" href="#qapidoc-628" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-632"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNull</span></code> (Object)<a class="headerlink" href="#qapidoc-632" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the null backend.</p> <div class="section" id="qapidoc-630"> <h5>Members<a class="headerlink" href="#qapidoc-630" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>size of the device in bytes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">latency-ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>emulated latency (in nanoseconds) in processing requests. Default to zero which completes requests immediately. (Since 2.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-zeroes</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, reads from the device produce zeroes; if false, the buffer is left unchanged. (default: false; since: 4.1)</dd> </dl> </div> <div class="section" id="qapidoc-631"> <h5>Since<a class="headerlink" href="#qapidoc-631" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-636"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNVMe</span></code> (Object)<a class="headerlink" href="#qapidoc-636" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the NVMe backend.</p> <div class="section" id="qapidoc-633"> <h5>Members<a class="headerlink" href="#qapidoc-633" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>PCI controller address of the NVMe device in format hhhh:bb:ss.f (host:bus:slot.function)</dd> <dt><code class="docutils literal notranslate"><span class="pre">namespace</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>namespace number of the device, starting from 1.</dd> </dl> </div> <div class="section" id="qapidoc-634"> Note that the PCI <code class="docutils literal notranslate"><span class="pre">device</span></code> must have been unbound from any host kernel driver before instructing QEMU to add the blockdev.</div> <div class="section" id="qapidoc-635"> <h5>Since<a class="headerlink" href="#qapidoc-635" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-639"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsVVFAT</span></code> (Object)<a class="headerlink" href="#qapidoc-639" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the vvfat protocol.</p> <div class="section" id="qapidoc-637"> <h5>Members<a class="headerlink" href="#qapidoc-637" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dir</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>directory to be exported as FAT image</dd> <dt><code class="docutils literal notranslate"><span class="pre">fat-type</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>FAT type: 12, 16 or 32</dd> <dt><code class="docutils literal notranslate"><span class="pre">floppy</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to export a floppy image (true) or partitioned hard disk (false; default)</dd> <dt><code class="docutils literal notranslate"><span class="pre">label</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>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)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rw</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to allow write operations (default: false)</dd> </dl> </div> <div class="section" id="qapidoc-638"> <h5>Since<a class="headerlink" href="#qapidoc-638" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-642"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> (Object)<a class="headerlink" href="#qapidoc-642" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for image format that have no option besides their data source.</p> <div class="section" id="qapidoc-640"> <h5>Members<a class="headerlink" href="#qapidoc-640" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>reference to or definition of the data source block device</dd> </dl> </div> <div class="section" id="qapidoc-641"> <h5>Since<a class="headerlink" href="#qapidoc-641" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-645"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsLUKS</span></code> (Object)<a class="headerlink" href="#qapidoc-645" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for LUKS.</p> <div class="section" id="qapidoc-643"> <h5>Members<a class="headerlink" href="#qapidoc-643" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the ID of a QCryptoSecret object providing the decryption key (since 2.6). Mandatory except when doing a metadata-only probe of the image.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-644"> <h5>Since<a class="headerlink" href="#qapidoc-644" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-648"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericCOWFormat</span></code> (Object)<a class="headerlink" href="#qapidoc-648" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for image format that have no option besides their data source and an optional backing file.</p> <div class="section" id="qapidoc-646"> <h5>Members<a class="headerlink" href="#qapidoc-646" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">backing</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRefOrNull</span></code> (optional)</dt> <dd>reference to or definition of the backing file block device, null disables the backing file entirely. Defaults to the backing file stored the image file.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-647"> <h5>Since<a class="headerlink" href="#qapidoc-647" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-651"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2OverlapCheckMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-651" title="Permalink to this headline">¶</a></h4> <p>General overlap check modes.</p> <div class="section" id="qapidoc-649"> <h5>Values<a class="headerlink" href="#qapidoc-649" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Do not perform any checks</dd> <dt><code class="docutils literal notranslate"><span class="pre">constant</span></code></dt> <dd>Perform only checks which can be done in constant time and without reading anything from disk</dd> <dt><code class="docutils literal notranslate"><span class="pre">cached</span></code></dt> <dd>Perform only checks which can be done without reading anything from disk</dd> <dt><code class="docutils literal notranslate"><span class="pre">all</span></code></dt> <dd>Perform all available overlap checks</dd> </dl> </div> <div class="section" id="qapidoc-650"> <h5>Since<a class="headerlink" href="#qapidoc-650" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-654"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2OverlapCheckFlags</span></code> (Object)<a class="headerlink" href="#qapidoc-654" title="Permalink to this headline">¶</a></h4> <p>Structure of flags for each metadata structure. Setting a field to ‘true’ makes qemu guard that structure against unintended overwriting. The default value is chosen according to the template given.</p> <div class="section" id="qapidoc-652"> <h5>Members<a class="headerlink" href="#qapidoc-652" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">template</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2OverlapCheckMode</span></code> (optional)</dt> <dd>Specifies a template mode which can be adjusted using the other flags, defaults to ‘cached’</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmap-directory</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>since 3.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">main-header</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">active-l1</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">active-l2</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refcount-table</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refcount-block</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot-table</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">inactive-l1</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">inactive-l2</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-653"> <h5>Since<a class="headerlink" href="#qapidoc-653" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-657"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2OverlapChecks</span></code> (Alternate)<a class="headerlink" href="#qapidoc-657" title="Permalink to this headline">¶</a></h4> <p>Specifies which metadata structures should be guarded against unintended overwriting.</p> <div class="section" id="qapidoc-655"> <h5>Members<a class="headerlink" href="#qapidoc-655" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">flags</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2OverlapCheckFlags</span></code></dt> <dd>set of flags for separate specification of each metadata structure type</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2OverlapCheckMode</span></code></dt> <dd>named mode which chooses a specific set of flags</dd> </dl> </div> <div class="section" id="qapidoc-656"> <h5>Since<a class="headerlink" href="#qapidoc-656" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-660"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevQcowEncryptionFormat</span></code> (Enum)<a class="headerlink" href="#qapidoc-660" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-658"> <h5>Values<a class="headerlink" href="#qapidoc-658" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">aes</span></code></dt> <dd>AES-CBC with plain64 initialization vectors</dd> </dl> </div> <div class="section" id="qapidoc-659"> <h5>Since<a class="headerlink" href="#qapidoc-659" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-663"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevQcowEncryption</span></code> (Object)<a class="headerlink" href="#qapidoc-663" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-661"> <h5>Members<a class="headerlink" href="#qapidoc-661" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcowEncryptionFormat</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"aes"</span></code></dl> </div> <div class="section" id="qapidoc-662"> <h5>Since<a class="headerlink" href="#qapidoc-662" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-666"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQcow</span></code> (Object)<a class="headerlink" href="#qapidoc-666" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for qcow.</p> <div class="section" id="qapidoc-664"> <h5>Members<a class="headerlink" href="#qapidoc-664" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcowEncryption</span></code> (optional)</dt> <dd>Image decryption options. Mandatory for encrypted images, except when doing a metadata-only probe of the image.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericCOWFormat</span></code></dl> </div> <div class="section" id="qapidoc-665"> <h5>Since<a class="headerlink" href="#qapidoc-665" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-669"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevQcow2EncryptionFormat</span></code> (Enum)<a class="headerlink" href="#qapidoc-669" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-667"> <h5>Values<a class="headerlink" href="#qapidoc-667" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">aes</span></code></dt> <dd>AES-CBC with plain64 initialization vectors</dd> <dt><code class="docutils literal notranslate"><span class="pre">luks</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-668"> <h5>Since<a class="headerlink" href="#qapidoc-668" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-672"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevQcow2Encryption</span></code> (Object)<a class="headerlink" href="#qapidoc-672" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-670"> <h5>Members<a class="headerlink" href="#qapidoc-670" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcow2EncryptionFormat</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsQCow</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"aes"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code></dl> </div> <div class="section" id="qapidoc-671"> <h5>Since<a class="headerlink" href="#qapidoc-671" title="Permalink to this headline">¶</a></h5> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-675"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsPreallocate</span></code> (Object)<a class="headerlink" href="#qapidoc-675" title="Permalink to this headline">¶</a></h4> <p>Filter driver intended to be inserted between format and protocol node and do preallocation in protocol node on write.</p> <div class="section" id="qapidoc-673"> <h5>Members<a class="headerlink" href="#qapidoc-673" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">prealloc-align</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>on preallocation, align file length to this number, default 1048576 (1M)</dd> <dt><code class="docutils literal notranslate"><span class="pre">prealloc-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>how much to preallocate, default 134217728 (128M)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-674"> <h5>Since<a class="headerlink" href="#qapidoc-674" title="Permalink to this headline">¶</a></h5> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-678"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQcow2</span></code> (Object)<a class="headerlink" href="#qapidoc-678" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for qcow2.</p> <div class="section" id="qapidoc-676"> <h5>Members<a class="headerlink" href="#qapidoc-676" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">lazy-refcounts</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to enable the lazy refcounts feature (default is taken from the image file)</dd> <dt><code class="docutils literal notranslate"><span class="pre">pass-discard-request</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether discard requests to the qcow2 device should be forwarded to the data source</dd> <dt><code class="docutils literal notranslate"><span class="pre">pass-discard-snapshot</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether discard requests for the data source should be issued when a snapshot operation (e.g. deleting a snapshot) frees clusters in the qcow2 file</dd> <dt><code class="docutils literal notranslate"><span class="pre">pass-discard-other</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether discard requests for the data source should be issued on other occasions where a cluster gets freed</dd> <dt><code class="docutils literal notranslate"><span class="pre">overlap-check</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2OverlapChecks</span></code> (optional)</dt> <dd>which overlap checks to perform for writes to the image, defaults to ‘cached’ (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum total size of the L2 table and refcount block caches in bytes (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2-cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum size of the L2 table cache in bytes (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2-cache-entry-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the size of each entry in the L2 cache in bytes. It must be a power of two between 512 and the cluster size. The default value is the cluster size (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">refcount-cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum size of the refcount block cache in bytes (since 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache-clean-interval</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>clean unused entries in the L2 and refcount caches. The interval is in seconds. The default value is 600 on supporting platforms, and 0 on other platforms. 0 disables this feature. (since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcow2Encryption</span></code> (optional)</dt> <dd>Image decryption options. Mandatory for encrypted images, except when doing a metadata-only probe of the image. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code> (optional)</dt> <dd>reference to or definition of the external data file. This may only be specified for images that require an external data file. If it is not specified for such an image, the data file name is loaded from the image file. (since 4.0)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericCOWFormat</span></code></dl> </div> <div class="section" id="qapidoc-677"> <h5>Since<a class="headerlink" href="#qapidoc-677" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-681"> <h4><code class="docutils literal notranslate"><span class="pre">SshHostKeyCheckMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-681" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-679"> <h5>Values<a class="headerlink" href="#qapidoc-679" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Don’t check the host key at all</dd> <dt><code class="docutils literal notranslate"><span class="pre">hash</span></code></dt> <dd>Compare the host key with a given hash</dd> <dt><code class="docutils literal notranslate"><span class="pre">known_hosts</span></code></dt> <dd>Check the host key against the known_hosts file</dd> </dl> </div> <div class="section" id="qapidoc-680"> <h5>Since<a class="headerlink" href="#qapidoc-680" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-684"> <h4><code class="docutils literal notranslate"><span class="pre">SshHostKeyCheckHashType</span></code> (Enum)<a class="headerlink" href="#qapidoc-684" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-682"> <h5>Values<a class="headerlink" href="#qapidoc-682" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">md5</span></code></dt> <dd>The given hash is an md5 hash</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha1</span></code></dt> <dd>The given hash is an sha1 hash</dd> <dt><code class="docutils literal notranslate"><span class="pre">sha256</span></code></dt> <dd>The given hash is an sha256 hash</dd> </dl> </div> <div class="section" id="qapidoc-683"> <h5>Since<a class="headerlink" href="#qapidoc-683" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-687"> <h4><code class="docutils literal notranslate"><span class="pre">SshHostKeyHash</span></code> (Object)<a class="headerlink" href="#qapidoc-687" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-685"> <h5>Members<a class="headerlink" href="#qapidoc-685" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">SshHostKeyCheckHashType</span></code></dt> <dd>The hash algorithm used for the hash</dd> <dt><code class="docutils literal notranslate"><span class="pre">hash</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The expected hash value</dd> </dl> </div> <div class="section" id="qapidoc-686"> <h5>Since<a class="headerlink" href="#qapidoc-686" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-690"> <h4><code class="docutils literal notranslate"><span class="pre">SshHostKeyCheck</span></code> (Object)<a class="headerlink" href="#qapidoc-690" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-688"> <h5>Members<a class="headerlink" href="#qapidoc-688" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">SshHostKeyCheckMode</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SshHostKeyHash</span></code> when <code class="docutils literal notranslate"><span class="pre">mode</span></code> is <code class="docutils literal notranslate"><span class="pre">"hash"</span></code></dl> </div> <div class="section" id="qapidoc-689"> <h5>Since<a class="headerlink" href="#qapidoc-689" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-693"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsSsh</span></code> (Object)<a class="headerlink" href="#qapidoc-693" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-691"> <h5>Members<a class="headerlink" href="#qapidoc-691" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">InetSocketAddress</span></code></dt> <dd>host address</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>path to the image on the host</dd> <dt><code class="docutils literal notranslate"><span class="pre">user</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>user as which to connect, defaults to current local user name</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-key-check</span></code>: <code class="docutils literal notranslate"><span class="pre">SshHostKeyCheck</span></code> (optional)</dt> <dd>Defines how and what to check the host key against (default: known_hosts)</dd> </dl> </div> <div class="section" id="qapidoc-692"> <h5>Since<a class="headerlink" href="#qapidoc-692" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-696"> <h4><code class="docutils literal notranslate"><span class="pre">BlkdebugEvent</span></code> (Enum)<a class="headerlink" href="#qapidoc-696" title="Permalink to this headline">¶</a></h4> <p>Trigger events supported by blkdebug.</p> <div class="section" id="qapidoc-694"> <h5>Values<a class="headerlink" href="#qapidoc-694" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">l1_shrink_write_table</span></code></dt> <dd>write zeros to the l1 table to shrink image. (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">l1_shrink_free_l2_clusters</span></code></dt> <dd>discard the l2 tables. (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cor_write</span></code></dt> <dd>a write due to copy-on-read (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster_alloc_space</span></code></dt> <dd>an allocation of file space for a cluster (since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>triggers once at creation of the blkdebug node (since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">l1_update</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l1_grow_alloc_table</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l1_grow_write_table</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l1_grow_activate_table</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2_load</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2_update</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2_update_compressed</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2_alloc_cow_read</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2_alloc_write</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">read_aio</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">read_backing_aio</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">read_compressed</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">write_aio</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">write_compressed</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate_load</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate_save</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cow_read</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cow_write</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">reftable_load</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">reftable_grow</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">reftable_update</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_load</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_update</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_update_part</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc_hookup</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc_write</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc_write_blocks</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc_write_table</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">refblock_alloc_switch_table</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster_alloc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster_alloc_bytes</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster_free</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush_to_os</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush_to_disk</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_rmw_head</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_rmw_after_head</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_rmw_tail</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_rmw_after_tail</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_zero</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pwritev_done</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">empty_image_prepare</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-695"> <h5>Since<a class="headerlink" href="#qapidoc-695" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-699"> <h4><code class="docutils literal notranslate"><span class="pre">BlkdebugIOType</span></code> (Enum)<a class="headerlink" href="#qapidoc-699" title="Permalink to this headline">¶</a></h4> <p>Kinds of I/O that blkdebug can inject errors in.</p> <div class="section" id="qapidoc-697"> <h5>Values<a class="headerlink" href="#qapidoc-697" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">read</span></code></dt> <dd>.bdrv_co_preadv()</dd> <dt><code class="docutils literal notranslate"><span class="pre">write</span></code></dt> <dd>.bdrv_co_pwritev()</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-zeroes</span></code></dt> <dd>.bdrv_co_pwrite_zeroes()</dd> <dt><code class="docutils literal notranslate"><span class="pre">discard</span></code></dt> <dd>.bdrv_co_pdiscard()</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush</span></code></dt> <dd>.bdrv_co_flush_to_disk()</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-status</span></code></dt> <dd>.bdrv_co_block_status()</dd> </dl> </div> <div class="section" id="qapidoc-698"> <h5>Since<a class="headerlink" href="#qapidoc-698" title="Permalink to this headline">¶</a></h5> <p>4.1</p> </div> </div> <div class="section" id="qapidoc-702"> <h4><code class="docutils literal notranslate"><span class="pre">BlkdebugInjectErrorOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-702" title="Permalink to this headline">¶</a></h4> <p>Describes a single error injection for blkdebug.</p> <div class="section" id="qapidoc-700"> <h5>Members<a class="headerlink" href="#qapidoc-700" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">event</span></code>: <code class="docutils literal notranslate"><span class="pre">BlkdebugEvent</span></code></dt> <dd>trigger event</dd> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the state identifier blkdebug needs to be in to actually trigger the event; defaults to “any”</dd> <dt><code class="docutils literal notranslate"><span class="pre">iotype</span></code>: <code class="docutils literal notranslate"><span class="pre">BlkdebugIOType</span></code> (optional)</dt> <dd>the type of I/O operations on which this error should be injected; defaults to “all read, write, write-zeroes, discard, and flush operations” (since: 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">errno</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>error identifier (errno) to be returned; defaults to EIO</dd> <dt><code class="docutils literal notranslate"><span class="pre">sector</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>specifies the sector index which has to be affected in order to actually trigger the event; defaults to “any sector”</dd> <dt><code class="docutils literal notranslate"><span class="pre">once</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>disables further events after this one has been triggered; defaults to false</dd> <dt><code class="docutils literal notranslate"><span class="pre">immediately</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>fail immediately; defaults to false</dd> </dl> </div> <div class="section" id="qapidoc-701"> <h5>Since<a class="headerlink" href="#qapidoc-701" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-705"> <h4><code class="docutils literal notranslate"><span class="pre">BlkdebugSetStateOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-705" title="Permalink to this headline">¶</a></h4> <p>Describes a single state-change event for blkdebug.</p> <div class="section" id="qapidoc-703"> <h5>Members<a class="headerlink" href="#qapidoc-703" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">event</span></code>: <code class="docutils literal notranslate"><span class="pre">BlkdebugEvent</span></code></dt> <dd>trigger event</dd> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the current state identifier blkdebug needs to be in; defaults to “any”</dd> <dt><code class="docutils literal notranslate"><span class="pre">new_state</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the state identifier blkdebug is supposed to assume if this event is triggered</dd> </dl> </div> <div class="section" id="qapidoc-704"> <h5>Since<a class="headerlink" href="#qapidoc-704" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-708"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkdebug</span></code> (Object)<a class="headerlink" href="#qapidoc-708" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for blkdebug.</p> <div class="section" id="qapidoc-706"> <h5>Members<a class="headerlink" href="#qapidoc-706" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">image</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>underlying raw block device (or image file)</dd> <dt><code class="docutils literal notranslate"><span class="pre">config</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>filename of the configuration file</dd> <dt><code class="docutils literal notranslate"><span class="pre">align</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>required alignment for requests in bytes, must be positive power of 2, or 0 for default</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-transfer</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum size for I/O transfers in bytes, must be positive multiple of <code class="docutils literal notranslate"><span class="pre">align</span></code> and of the underlying file’s request alignment (but need not be a power of 2), or 0 for default (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">opt-write-zero</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>preferred alignment for write zero requests in bytes, must be positive multiple of <code class="docutils literal notranslate"><span class="pre">align</span></code> and of the underlying file’s request alignment (but need not be a power of 2), or 0 for default (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-write-zero</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum size for write zero requests in bytes, must be positive multiple of <code class="docutils literal notranslate"><span class="pre">align</span></code>, of <code class="docutils literal notranslate"><span class="pre">opt-write-zero</span></code>, and of the underlying file’s request alignment (but need not be a power of 2), or 0 for default (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">opt-discard</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>preferred alignment for discard requests in bytes, must be positive multiple of <code class="docutils literal notranslate"><span class="pre">align</span></code> and of the underlying file’s request alignment (but need not be a power of 2), or 0 for default (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-discard</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum size for discard requests in bytes, must be positive multiple of <code class="docutils literal notranslate"><span class="pre">align</span></code>, of <code class="docutils literal notranslate"><span class="pre">opt-discard</span></code>, and of the underlying file’s request alignment (but need not be a power of 2), or 0 for default (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">inject-error</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlkdebugInjectErrorOptions</span></code> (optional)</dt> <dd>array of error injection descriptions</dd> <dt><code class="docutils literal notranslate"><span class="pre">set-state</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlkdebugSetStateOptions</span></code> (optional)</dt> <dd>array of state-change descriptions</dd> <dt><code class="docutils literal notranslate"><span class="pre">take-child-perms</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockPermission</span></code> (optional)</dt> <dd>Permissions to take on <code class="docutils literal notranslate"><span class="pre">image</span></code> in addition to what is necessary anyway (which depends on how the blkdebug node is used). Defaults to none. (since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unshare-child-perms</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockPermission</span></code> (optional)</dt> <dd>Permissions not to share on <code class="docutils literal notranslate"><span class="pre">image</span></code> in addition to what cannot be shared anyway (which depends on how the blkdebug node is used). Defaults to none. (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-707"> <h5>Since<a class="headerlink" href="#qapidoc-707" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-711"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlklogwrites</span></code> (Object)<a class="headerlink" href="#qapidoc-711" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for blklogwrites.</p> <div class="section" id="qapidoc-709"> <h5>Members<a class="headerlink" href="#qapidoc-709" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>block device</dd> <dt><code class="docutils literal notranslate"><span class="pre">log</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>block device used to log writes to <code class="docutils literal notranslate"><span class="pre">file</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">log-sector-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>sector size used in logging writes to <code class="docutils literal notranslate"><span class="pre">file</span></code>, determines granularity of offsets and sizes of writes (default: 512)</dd> <dt><code class="docutils literal notranslate"><span class="pre">log-append</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>append to an existing log (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">log-super-update-interval</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>interval of write requests after which the log super block is updated to disk (default: 4096)</dd> </dl> </div> <div class="section" id="qapidoc-710"> <h5>Since<a class="headerlink" href="#qapidoc-710" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-714"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkverify</span></code> (Object)<a class="headerlink" href="#qapidoc-714" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for blkverify.</p> <div class="section" id="qapidoc-712"> <h5>Members<a class="headerlink" href="#qapidoc-712" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">test</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>block device to be tested</dd> <dt><code class="docutils literal notranslate"><span class="pre">raw</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>raw image used for verification</dd> </dl> </div> <div class="section" id="qapidoc-713"> <h5>Since<a class="headerlink" href="#qapidoc-713" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-717"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkreplay</span></code> (Object)<a class="headerlink" href="#qapidoc-717" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for blkreplay.</p> <div class="section" id="qapidoc-715"> <h5>Members<a class="headerlink" href="#qapidoc-715" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">image</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>disk image which should be controlled with blkreplay</dd> </dl> </div> <div class="section" id="qapidoc-716"> <h5>Since<a class="headerlink" href="#qapidoc-716" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-720"> <h4><code class="docutils literal notranslate"><span class="pre">QuorumReadPattern</span></code> (Enum)<a class="headerlink" href="#qapidoc-720" title="Permalink to this headline">¶</a></h4> <p>An enumeration of quorum read patterns.</p> <div class="section" id="qapidoc-718"> <h5>Values<a class="headerlink" href="#qapidoc-718" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">quorum</span></code></dt> <dd>read all the children and do a quorum vote on reads</dd> <dt><code class="docutils literal notranslate"><span class="pre">fifo</span></code></dt> <dd>read only from the first child that has not failed</dd> </dl> </div> <div class="section" id="qapidoc-719"> <h5>Since<a class="headerlink" href="#qapidoc-719" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-723"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQuorum</span></code> (Object)<a class="headerlink" href="#qapidoc-723" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for Quorum</p> <div class="section" id="qapidoc-721"> <h5>Members<a class="headerlink" href="#qapidoc-721" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">blkverify</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>true if the driver must print content mismatch</dt> <dd>set to false by default</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">children</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockdevRef</span></code></dt> <dd>the children block devices to use</dd> <dt><code class="docutils literal notranslate"><span class="pre">vote-threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the vote limit under which a read will fail</dd> <dt><code class="docutils literal notranslate"><span class="pre">rewrite-corrupted</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>rewrite corrupted data when quorum is reached (Since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-pattern</span></code>: <code class="docutils literal notranslate"><span class="pre">QuorumReadPattern</span></code> (optional)</dt> <dd>choose read pattern and set to quorum by default (Since 2.2)</dd> </dl> </div> <div class="section" id="qapidoc-722"> <h5>Since<a class="headerlink" href="#qapidoc-722" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-726"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGluster</span></code> (Object)<a class="headerlink" href="#qapidoc-726" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for Gluster</p> <div class="section" id="qapidoc-724"> <h5>Members<a class="headerlink" href="#qapidoc-724" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">volume</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of gluster volume where VM image resides</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>absolute path to image file in gluster volume</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SocketAddress</span></code></dt> <dd>gluster servers description</dd> <dt><code class="docutils literal notranslate"><span class="pre">debug</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>libgfapi log level (default ‘4’ which is Error) (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">logfile</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>libgfapi log file (default /dev/stderr) (Since 2.8)</dd> </dl> </div> <div class="section" id="qapidoc-725"> <h5>Since<a class="headerlink" href="#qapidoc-725" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-729"> <h4><code class="docutils literal notranslate"><span class="pre">IscsiTransport</span></code> (Enum)<a class="headerlink" href="#qapidoc-729" title="Permalink to this headline">¶</a></h4> <p>An enumeration of libiscsi transport types</p> <div class="section" id="qapidoc-727"> <h5>Values<a class="headerlink" href="#qapidoc-727" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">tcp</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">iser</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-728"> <h5>Since<a class="headerlink" href="#qapidoc-728" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-732"> <h4><code class="docutils literal notranslate"><span class="pre">IscsiHeaderDigest</span></code> (Enum)<a class="headerlink" href="#qapidoc-732" title="Permalink to this headline">¶</a></h4> <p>An enumeration of header digests supported by libiscsi</p> <div class="section" id="qapidoc-730"> <h5>Values<a class="headerlink" href="#qapidoc-730" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">crc32c</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">crc32c-none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">none-crc32c</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-731"> <h5>Since<a class="headerlink" href="#qapidoc-731" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-736"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsIscsi</span></code> (Object)<a class="headerlink" href="#qapidoc-736" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-733"> <h5>Members<a class="headerlink" href="#qapidoc-733" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">transport</span></code>: <code class="docutils literal notranslate"><span class="pre">IscsiTransport</span></code></dt> <dd>The iscsi transport type</dd> <dt><code class="docutils literal notranslate"><span class="pre">portal</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The address of the iscsi portal</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The target iqn name</dd> <dt><code class="docutils literal notranslate"><span class="pre">lun</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>LUN to connect to. Defaults to 0.</dd> <dt><code class="docutils literal notranslate"><span class="pre">user</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>User name to log in with. If omitted, no CHAP authentication is performed.</dd> <dt><code class="docutils literal notranslate"><span class="pre">password-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The ID of a QCryptoSecret object providing the password for the login. This option is required if <code class="docutils literal notranslate"><span class="pre">user</span></code> is specified.</dd> <dt><code class="docutils literal notranslate"><span class="pre">initiator-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The iqn name we want to identify to the target as. If this option is not specified, an initiator name is generated automatically.</dd> <dt><code class="docutils literal notranslate"><span class="pre">header-digest</span></code>: <code class="docutils literal notranslate"><span class="pre">IscsiHeaderDigest</span></code> (optional)</dt> <dd>The desired header digest. Defaults to none-crc32c.</dd> <dt><code class="docutils literal notranslate"><span class="pre">timeout</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Timeout in seconds after which a request will timeout. 0 means no timeout and is the default.</dd> </dl> </div> <div class="section" id="qapidoc-734"> Driver specific block device options for iscsi</div> <div class="section" id="qapidoc-735"> <h5>Since<a class="headerlink" href="#qapidoc-735" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-739"> <h4><code class="docutils literal notranslate"><span class="pre">RbdAuthMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-739" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-737"> <h5>Values<a class="headerlink" href="#qapidoc-737" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cephx</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-738"> <h5>Since<a class="headerlink" href="#qapidoc-738" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-742"> <h4><code class="docutils literal notranslate"><span class="pre">RbdImageEncryptionFormat</span></code> (Enum)<a class="headerlink" href="#qapidoc-742" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-740"> <h5>Values<a class="headerlink" href="#qapidoc-740" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">luks</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">luks2</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-741"> <h5>Since<a class="headerlink" href="#qapidoc-741" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-745"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKSBase</span></code> (Object)<a class="headerlink" href="#qapidoc-745" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-743"> <h5>Members<a class="headerlink" href="#qapidoc-743" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>ID of a QCryptoSecret object providing a passphrase for unlocking the encryption</dd> </dl> </div> <div class="section" id="qapidoc-744"> <h5>Since<a class="headerlink" href="#qapidoc-744" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-748"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKSBase</span></code> (Object)<a class="headerlink" href="#qapidoc-748" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-746"> <h5>Members<a class="headerlink" href="#qapidoc-746" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cipher-alg</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoCipherAlgorithm</span></code> (optional)</dt> <dd>The encryption algorithm</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKSBase</span></code></dl> </div> <div class="section" id="qapidoc-747"> <h5>Since<a class="headerlink" href="#qapidoc-747" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-751"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKS</span></code> (Object)<a class="headerlink" href="#qapidoc-751" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-749"> <h5>Members<a class="headerlink" href="#qapidoc-749" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKSBase</span></code></dl> </div> <div class="section" id="qapidoc-750"> <h5>Since<a class="headerlink" href="#qapidoc-750" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-754"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKS2</span></code> (Object)<a class="headerlink" href="#qapidoc-754" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-752"> <h5>Members<a class="headerlink" href="#qapidoc-752" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKSBase</span></code></dl> </div> <div class="section" id="qapidoc-753"> <h5>Since<a class="headerlink" href="#qapidoc-753" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-757"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKS</span></code> (Object)<a class="headerlink" href="#qapidoc-757" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-755"> <h5>Members<a class="headerlink" href="#qapidoc-755" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKSBase</span></code></dl> </div> <div class="section" id="qapidoc-756"> <h5>Since<a class="headerlink" href="#qapidoc-756" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-760"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKS2</span></code> (Object)<a class="headerlink" href="#qapidoc-760" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-758"> <h5>Members<a class="headerlink" href="#qapidoc-758" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKSBase</span></code></dl> </div> <div class="section" id="qapidoc-759"> <h5>Since<a class="headerlink" href="#qapidoc-759" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-763"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-763" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-761"> <h5>Members<a class="headerlink" href="#qapidoc-761" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">RbdImageEncryptionFormat</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptionsLUKS2</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks2"</span></code></dl> </div> <div class="section" id="qapidoc-762"> <h5>Since<a class="headerlink" href="#qapidoc-762" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-766"> <h4><code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-766" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-764"> <h5>Members<a class="headerlink" href="#qapidoc-764" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">RbdImageEncryptionFormat</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptionsLUKS2</span></code> when <code class="docutils literal notranslate"><span class="pre">format</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks2"</span></code></dl> </div> <div class="section" id="qapidoc-765"> <h5>Since<a class="headerlink" href="#qapidoc-765" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-769"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsRbd</span></code> (Object)<a class="headerlink" href="#qapidoc-769" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-767"> <h5>Members<a class="headerlink" href="#qapidoc-767" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pool</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Ceph pool name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">namespace</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Rados namespace name in the Ceph pool. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">image</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Image name in the Ceph pool.</dd> <dt><code class="docutils literal notranslate"><span class="pre">conf</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>path to Ceph configuration file. Values in the configuration file will be overridden by options specified via QAPI.</dd> <dt><code class="docutils literal notranslate"><span class="pre">snapshot</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ceph snapshot name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">RbdEncryptionOptions</span></code> (optional)</dt> <dd>Image encryption options. (Since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">user</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ceph id name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auth-client-required</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">RbdAuthMode</span></code> (optional)</dt> <dd>Acceptable authentication modes. This maps to Ceph configuration option “auth_client_required”. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">key-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of a QCryptoSecret object providing a key for cephx authentication. This maps to Ceph configuration option “key”. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">InetSocketAddressBase</span></code> (optional)</dt> <dd>Monitor host address and port. This maps to the “mon_host” Ceph option.</dd> </dl> </div> <div class="section" id="qapidoc-768"> <h5>Since<a class="headerlink" href="#qapidoc-768" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-773"> <h4><code class="docutils literal notranslate"><span class="pre">ReplicationMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-773" title="Permalink to this headline">¶</a></h4> <p>An enumeration of replication modes.</p> <div class="section" id="qapidoc-770"> <h5>Values<a class="headerlink" href="#qapidoc-770" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">primary</span></code></dt> <dd>Primary mode, the vm’s state will be sent to secondary QEMU.</dd> <dt><code class="docutils literal notranslate"><span class="pre">secondary</span></code></dt> <dd>Secondary mode, receive the vm’s state from primary QEMU.</dd> </dl> </div> <div class="section" id="qapidoc-771"> <h5>Since<a class="headerlink" href="#qapidoc-771" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> <div class="section" id="qapidoc-772"> <h5>If<a class="headerlink" href="#qapidoc-772" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-777"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsReplication</span></code> (Object)<a class="headerlink" href="#qapidoc-777" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for replication</p> <div class="section" id="qapidoc-774"> <h5>Members<a class="headerlink" href="#qapidoc-774" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">ReplicationMode</span></code></dt> <dd>the replication mode</dd> <dt><code class="docutils literal notranslate"><span class="pre">top-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>In secondary mode, node name or device ID of the root node who owns the replication node chain. Must not be given in primary mode.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-775"> <h5>Since<a class="headerlink" href="#qapidoc-775" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> <div class="section" id="qapidoc-776"> <h5>If<a class="headerlink" href="#qapidoc-776" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-780"> <h4><code class="docutils literal notranslate"><span class="pre">NFSTransport</span></code> (Enum)<a class="headerlink" href="#qapidoc-780" title="Permalink to this headline">¶</a></h4> <p>An enumeration of NFS transport types</p> <div class="section" id="qapidoc-778"> <h5>Values<a class="headerlink" href="#qapidoc-778" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">inet</span></code></dt> <dd>TCP transport</dd> </dl> </div> <div class="section" id="qapidoc-779"> <h5>Since<a class="headerlink" href="#qapidoc-779" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-783"> <h4><code class="docutils literal notranslate"><span class="pre">NFSServer</span></code> (Object)<a class="headerlink" href="#qapidoc-783" title="Permalink to this headline">¶</a></h4> <p>Captures the address of the socket</p> <div class="section" id="qapidoc-781"> <h5>Members<a class="headerlink" href="#qapidoc-781" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">NFSTransport</span></code></dt> <dd>transport type used for NFS (only TCP supported)</dd> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>host address for NFS server</dd> </dl> </div> <div class="section" id="qapidoc-782"> <h5>Since<a class="headerlink" href="#qapidoc-782" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-786"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNfs</span></code> (Object)<a class="headerlink" href="#qapidoc-786" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device option for NFS</p> <div class="section" id="qapidoc-784"> <h5>Members<a class="headerlink" href="#qapidoc-784" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">NFSServer</span></code></dt> <dd>host address</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>path of the image on the host</dd> <dt><code class="docutils literal notranslate"><span class="pre">user</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>UID value to use when talking to the server (defaults to 65534 on Windows and getuid() on unix)</dd> <dt><code class="docutils literal notranslate"><span class="pre">group</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>GID value to use when talking to the server (defaults to 65534 on Windows and getgid() in unix)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tcp-syn-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of SYNs during the session establishment (defaults to libnfs default)</dd> <dt><code class="docutils literal notranslate"><span class="pre">readahead-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set the readahead size in bytes (defaults to libnfs default)</dd> <dt><code class="docutils literal notranslate"><span class="pre">page-cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set the pagecache size in bytes (defaults to libnfs default)</dd> <dt><code class="docutils literal notranslate"><span class="pre">debug</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set the NFS debug level (max 2) (defaults to libnfs default)</dd> </dl> </div> <div class="section" id="qapidoc-785"> <h5>Since<a class="headerlink" href="#qapidoc-785" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-789"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlBase</span></code> (Object)<a class="headerlink" href="#qapidoc-789" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options shared by all protocols supported by the curl backend.</p> <div class="section" id="qapidoc-787"> <h5>Members<a class="headerlink" href="#qapidoc-787" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">url</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>URL of the image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">readahead</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Size of the read-ahead cache; must be a multiple of 512 (defaults to 256 kB)</dd> <dt><code class="docutils literal notranslate"><span class="pre">timeout</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Timeout for connections, in seconds (defaults to 5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">username</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Username for authentication (defaults to none)</dd> <dt><code class="docutils literal notranslate"><span class="pre">password-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of a QCryptoSecret object providing a password for authentication (defaults to no password)</dd> <dt><code class="docutils literal notranslate"><span class="pre">proxy-username</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Username for proxy authentication (defaults to none)</dd> <dt><code class="docutils literal notranslate"><span class="pre">proxy-password-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of a QCryptoSecret object providing a password for proxy authentication (defaults to no password)</dd> </dl> </div> <div class="section" id="qapidoc-788"> <h5>Since<a class="headerlink" href="#qapidoc-788" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-792"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlHttp</span></code> (Object)<a class="headerlink" href="#qapidoc-792" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for HTTP connections over the curl backend. URLs must start with “<a class="reference external" href="http://">http://</a>”.</p> <div class="section" id="qapidoc-790"> <h5>Members<a class="headerlink" href="#qapidoc-790" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cookie</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>List of cookies to set; format is “name1=content1; name2=content2;” as explained by CURLOPT_COOKIE(3). Defaults to no cookies.</dd> <dt><code class="docutils literal notranslate"><span class="pre">cookie-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of a QCryptoSecret object providing the cookie data in a secure way. See <code class="docutils literal notranslate"><span class="pre">cookie</span></code> for the format. (since 2.10)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlBase</span></code></dl> </div> <div class="section" id="qapidoc-791"> <h5>Since<a class="headerlink" href="#qapidoc-791" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-795"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlHttps</span></code> (Object)<a class="headerlink" href="#qapidoc-795" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for HTTPS connections over the curl backend. URLs must start with “<a class="reference external" href="https://">https://</a>”.</p> <div class="section" id="qapidoc-793"> <h5>Members<a class="headerlink" href="#qapidoc-793" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cookie</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>List of cookies to set; format is “name1=content1; name2=content2;” as explained by CURLOPT_COOKIE(3). Defaults to no cookies.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sslverify</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Whether to verify the SSL certificate’s validity (defaults to true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cookie-secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of a QCryptoSecret object providing the cookie data in a secure way. See <code class="docutils literal notranslate"><span class="pre">cookie</span></code> for the format. (since 2.10)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlBase</span></code></dl> </div> <div class="section" id="qapidoc-794"> <h5>Since<a class="headerlink" href="#qapidoc-794" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-798"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlFtp</span></code> (Object)<a class="headerlink" href="#qapidoc-798" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for FTP connections over the curl backend. URLs must start with “<a class="reference external" href="ftp://">ftp://</a>”.</p> <div class="section" id="qapidoc-796"> <h5>Members<a class="headerlink" href="#qapidoc-796" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlBase</span></code></dl> </div> <div class="section" id="qapidoc-797"> <h5>Since<a class="headerlink" href="#qapidoc-797" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-801"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlFtps</span></code> (Object)<a class="headerlink" href="#qapidoc-801" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for FTPS connections over the curl backend. URLs must start with “ftps://”.</p> <div class="section" id="qapidoc-799"> <h5>Members<a class="headerlink" href="#qapidoc-799" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sslverify</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Whether to verify the SSL certificate’s validity (defaults to true)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlBase</span></code></dl> </div> <div class="section" id="qapidoc-800"> <h5>Since<a class="headerlink" href="#qapidoc-800" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-805"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNbd</span></code> (Object)<a class="headerlink" href="#qapidoc-805" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for NBD.</p> <div class="section" id="qapidoc-802"> <h5>Members<a class="headerlink" href="#qapidoc-802" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code></dt> <dd>NBD server address</dd> <dt><code class="docutils literal notranslate"><span class="pre">export</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>export name</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>TLS credentials ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-dirty-bitmap</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>A metadata context name such as “qemu:dirty-bitmap:NAME” or “qemu:allocation-depth” to query in place of the traditional “base:allocation” block status (see NBD_OPT_LIST_META_CONTEXT in the NBD protocol; and yes, naming this option x-context would have made more sense) (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reconnect-delay</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>On an unexpected disconnect, the nbd client tries to connect again until succeeding or encountering a serious error. During the first <code class="docutils literal notranslate"><span class="pre">reconnect-delay</span></code> seconds, all requests are paused and will be rerun on a successful reconnect. After that time, any delayed requests and all future requests before a successful reconnect will immediately fail. Default 0 (Since 4.2)</dd> </dl> </div> <div class="section" id="qapidoc-803"> <h5>Features<a class="headerlink" href="#qapidoc-803" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-dirty-bitmap</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-804"> <h5>Since<a class="headerlink" href="#qapidoc-804" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-808"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsRaw</span></code> (Object)<a class="headerlink" href="#qapidoc-808" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the raw driver.</p> <div class="section" id="qapidoc-806"> <h5>Members<a class="headerlink" href="#qapidoc-806" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>position where the block device starts</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the assumed size of the device</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-807"> <h5>Since<a class="headerlink" href="#qapidoc-807" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-811"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsThrottle</span></code> (Object)<a class="headerlink" href="#qapidoc-811" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the throttle driver</p> <div class="section" id="qapidoc-809"> <h5>Members<a class="headerlink" href="#qapidoc-809" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">throttle-group</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the throttle-group object to use. It must already exist.</dd> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>reference to or definition of the data source block device</dd> </dl> </div> <div class="section" id="qapidoc-810"> <h5>Since<a class="headerlink" href="#qapidoc-810" title="Permalink to this headline">¶</a></h5> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-814"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCor</span></code> (Object)<a class="headerlink" href="#qapidoc-814" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the copy-on-read driver.</p> <div class="section" id="qapidoc-812"> <h5>Members<a class="headerlink" href="#qapidoc-812" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bottom</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name of a non-filter node (allocation-bearing layer) that limits the COR operations in the backing chain (inclusive), so that no data below this node will be copied by this filter. If option is absent, the limit is not applied, so that data from all backing layers may be copied.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-813"> <h5>Since<a class="headerlink" href="#qapidoc-813" title="Permalink to this headline">¶</a></h5> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-817"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCbw</span></code> (Object)<a class="headerlink" href="#qapidoc-817" title="Permalink to this headline">¶</a></h4> <p>Driver specific block device options for the copy-before-write driver, which does so called copy-before-write operations: when data is written to the filter, the filter first reads corresponding blocks from its file child and copies them to <code class="docutils literal notranslate"><span class="pre">target</span></code> child. After successfully copying, the write request is propagated to file child. If copying fails, the original write request is failed too and no data is written to file child.</p> <div class="section" id="qapidoc-815"> <h5>Members<a class="headerlink" href="#qapidoc-815" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>The target for copy-before-write operations.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code></dl> </div> <div class="section" id="qapidoc-816"> <h5>Since<a class="headerlink" href="#qapidoc-816" title="Permalink to this headline">¶</a></h5> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-821"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-821" title="Permalink to this headline">¶</a></h4> <p>Options for creating a block device. Many options are available for all block devices, independent of the block driver:</p> <div class="section" id="qapidoc-818"> <h5>Members<a class="headerlink" href="#qapidoc-818" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code></dt> <dd>block driver name</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the node name of the new node (Since 2.0). This option is required on the top level of blockdev-add. Valid node names start with an alphabetic character and may contain only alphanumeric characters, ‘-‘, ‘.’ and ‘_’. Their maximum length is 31 characters.</dd> <dt><code class="docutils literal notranslate"><span class="pre">discard</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDiscardOptions</span></code> (optional)</dt> <dd>discard-related options (default: ignore)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevCacheOptions</span></code> (optional)</dt> <dd>cache-related options</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-only</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether the block device should be read-only (default: false). Note that some block drivers support only read-only access, either generally or in certain configurations. In this case, the default value does not work and the option must be specified explicitly.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-read-only</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true and <code class="docutils literal notranslate"><span class="pre">read-only</span></code> is false, QEMU may automatically decide not to open the image read-write as requested, but fall back to read-only instead (and switch between the modes later), e.g. depending on whether the image file is writable or whether a writing user is attached to the node (default: false, since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">detect-zeroes</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDetectZeroesOptions</span></code> (optional)</dt> <dd>detect and optimize zero writes (Since 2.1) (default: off)</dd> <dt><code class="docutils literal notranslate"><span class="pre">force-share</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>force share all permission on added nodes. Requires read-only=true. (Since 2.10)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkdebug</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"blkdebug"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlklogwrites</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"blklogwrites"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkverify</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"blkverify"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsBlkreplay</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"blkreplay"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"bochs"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"cloop"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"compress"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCbw</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"copy-before-write"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCor</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"copy-on-read"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"dmg"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"file"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlFtp</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"ftp"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlFtps</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"ftps"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGluster</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"gluster"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"host_cdrom"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_HOST_BLOCK_DEVICE</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"host_device"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">HAVE_HOST_BLOCK_DEVICE</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlHttp</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"http"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsCurlHttps</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"https"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsIscsi</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"iscsi"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNbd</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"nbd"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNfs</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"nfs"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNull</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"null-aio"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNull</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"null-co"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNVMe</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"nvme"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"parallels"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsPreallocate</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"preallocate"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQcow2</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow2"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQcow</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericCOWFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qed"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsQuorum</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"quorum"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsRaw</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"raw"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsRbd</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"rbd"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsReplication</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"replication"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsSsh</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"ssh"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsThrottle</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"throttle"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vdi"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vhdx"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericCOWFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vmdk"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGenericFormat</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vpc"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsVVFAT</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vvfat"</span></code></dl> </div> <div class="section" id="qapidoc-819"> Remaining options are determined by the block driver.</div> <div class="section" id="qapidoc-820"> <h5>Since<a class="headerlink" href="#qapidoc-820" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-824"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code> (Alternate)<a class="headerlink" href="#qapidoc-824" title="Permalink to this headline">¶</a></h4> <p>Reference to a block device.</p> <div class="section" id="qapidoc-822"> <h5>Members<a class="headerlink" href="#qapidoc-822" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">definition</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptions</span></code></dt> <dd>defines a new block device inline</dd> <dt><code class="docutils literal notranslate"><span class="pre">reference</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>references the ID of an existing block device</dd> </dl> </div> <div class="section" id="qapidoc-823"> <h5>Since<a class="headerlink" href="#qapidoc-823" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-827"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevRefOrNull</span></code> (Alternate)<a class="headerlink" href="#qapidoc-827" title="Permalink to this headline">¶</a></h4> <p>Reference to a block device.</p> <div class="section" id="qapidoc-825"> <h5>Members<a class="headerlink" href="#qapidoc-825" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">definition</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptions</span></code></dt> <dd>defines a new block device inline</dd> <dt><code class="docutils literal notranslate"><span class="pre">reference</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>references the ID of an existing block device. An empty string means that no block device should be referenced. Deprecated; use null instead.</dd> <dt><code class="docutils literal notranslate"><span class="pre">null</span></code>: <code class="docutils literal notranslate"><span class="pre">null</span></code></dt> <dd>No block device should be referenced (since 2.10)</dd> </dl> </div> <div class="section" id="qapidoc-826"> <h5>Since<a class="headerlink" href="#qapidoc-826" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-831"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-add</span></code> (Command)<a class="headerlink" href="#qapidoc-831" title="Permalink to this headline">¶</a></h4> <p>Creates a new block device.</p> <div class="section" id="qapidoc-828"> <h5>Arguments<a class="headerlink" href="#qapidoc-828" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevOptions</span></code></dl> </div> <div class="section" id="qapidoc-829"> <h5>Since<a class="headerlink" href="#qapidoc-829" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> <div class="section" id="qapidoc-830"> <h5>Example<a class="headerlink" href="#qapidoc-830" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"test1"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"test.qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"discard"</span><span class="p">:</span> <span class="s2">"unmap"</span><span class="p">,</span> <span class="s2">"cache"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"direct"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/test.qcow2"</span> <span class="p">},</span> <span class="s2">"backing"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"raw"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/dev/fdset/4"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-834"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-reopen</span></code> (Command)<a class="headerlink" href="#qapidoc-834" title="Permalink to this headline">¶</a></h4> <p>Reopens one or more block devices using the given set of options. Any option not specified will be reset to its default value regardless of its previous status. If an option cannot be changed or a particular driver does not support reopening then the command will return an error. All devices in the list are reopened in one transaction, so if one of them fails then the whole transaction is cancelled.</p> <p>The command receives a list of block devices to reopen. For each one of them, the top-level <code class="docutils literal notranslate"><span class="pre">node-name</span></code> option (from BlockdevOptions) must be specified and is used to select the block device to be reopened. Other <code class="docutils literal notranslate"><span class="pre">node-name</span></code> options must be either omitted or set to the current name of the appropriate node. This command won’t change any node name and any attempt to do it will result in an error.</p> <p>In the case of options that refer to child nodes, the behavior of this command depends on the value:</p> <blockquote> <div><ol class="arabic simple"> <li>A set of options (BlockdevOptions): the child is reopened with the specified set of options.</li> <li>A reference to the current child: the child is reopened using its existing set of options.</li> <li>A reference to a different node: the current child is replaced with the specified one.</li> <li>NULL: the current child (if any) is detached.</li> </ol> </div></blockquote> <p>Options (1) and (2) are supported in all cases. Option (3) is supported for <code class="docutils literal notranslate"><span class="pre">file</span></code> and <code class="docutils literal notranslate"><span class="pre">backing</span></code>, and option (4) for <code class="docutils literal notranslate"><span class="pre">backing</span></code> only.</p> <p>Unlike with blockdev-add, the <code class="docutils literal notranslate"><span class="pre">backing</span></code> option must always be present unless the node being reopened does not have a backing file and its image does not have a default backing file name as part of its metadata.</p> <div class="section" id="qapidoc-832"> <h5>Arguments<a class="headerlink" href="#qapidoc-832" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">options</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockdevOptions</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-833"> <h5>Since<a class="headerlink" href="#qapidoc-833" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-838"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-del</span></code> (Command)<a class="headerlink" href="#qapidoc-838" title="Permalink to this headline">¶</a></h4> <p>Deletes a block device that has been added using blockdev-add. The command will fail if the node is attached to a device or is otherwise being used.</p> <div class="section" id="qapidoc-835"> <h5>Arguments<a class="headerlink" href="#qapidoc-835" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Name of the graph node to delete.</dd> </dl> </div> <div class="section" id="qapidoc-836"> <h5>Since<a class="headerlink" href="#qapidoc-836" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> <div class="section" id="qapidoc-837"> <h5>Example<a class="headerlink" href="#qapidoc-837" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"qcow2"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"test.qcow2"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-del"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-841"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsFile</span></code> (Object)<a class="headerlink" href="#qapidoc-841" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for file.</p> <div class="section" id="qapidoc-839"> <h5>Members<a class="headerlink" href="#qapidoc-839" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Filename for the new image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocation</span></code>: <code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (optional)</dt> <dd>Preallocation mode for the new image (default: off; allowed values: off, falloc (if CONFIG_POSIX_FALLOCATE), full (if CONFIG_POSIX))</dd> <dt><code class="docutils literal notranslate"><span class="pre">nocow</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Turn off copy-on-write (valid only on btrfs; default: off)</dd> <dt><code class="docutils literal notranslate"><span class="pre">extent-size-hint</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Extent size hint to add to the image file; 0 for not adding an extent size hint (default: 1 MB, since 5.1)</dd> </dl> </div> <div class="section" id="qapidoc-840"> <h5>Since<a class="headerlink" href="#qapidoc-840" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-844"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsGluster</span></code> (Object)<a class="headerlink" href="#qapidoc-844" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for gluster.</p> <div class="section" id="qapidoc-842"> <h5>Members<a class="headerlink" href="#qapidoc-842" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">location</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsGluster</span></code></dt> <dd>Where to store the new image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocation</span></code>: <code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (optional)</dt> <dd>Preallocation mode for the new image (default: off; allowed values: off, falloc (if CONFIG_GLUSTERFS_FALLOCATE), full (if CONFIG_GLUSTERFS_ZEROFILL))</dd> </dl> </div> <div class="section" id="qapidoc-843"> <h5>Since<a class="headerlink" href="#qapidoc-843" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-847"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsLUKS</span></code> (Object)<a class="headerlink" href="#qapidoc-847" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for LUKS.</p> <div class="section" id="qapidoc-845"> <h5>Members<a class="headerlink" href="#qapidoc-845" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocation</span></code>: <code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (optional)</dt> <dd>Preallocation mode for the new image (since: 4.2) (default: off; allowed values: off, metadata, falloc, full)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptionsLUKS</span></code></dl> </div> <div class="section" id="qapidoc-846"> <h5>Since<a class="headerlink" href="#qapidoc-846" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-850"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsNfs</span></code> (Object)<a class="headerlink" href="#qapidoc-850" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for NFS.</p> <div class="section" id="qapidoc-848"> <h5>Members<a class="headerlink" href="#qapidoc-848" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">location</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsNfs</span></code></dt> <dd>Where to store the new image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> </dl> </div> <div class="section" id="qapidoc-849"> <h5>Since<a class="headerlink" href="#qapidoc-849" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-853"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsParallels</span></code> (Object)<a class="headerlink" href="#qapidoc-853" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for parallels.</p> <div class="section" id="qapidoc-851"> <h5>Members<a class="headerlink" href="#qapidoc-851" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Cluster size in bytes (default: 1 MB)</dd> </dl> </div> <div class="section" id="qapidoc-852"> <h5>Since<a class="headerlink" href="#qapidoc-852" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-856"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQcow</span></code> (Object)<a class="headerlink" href="#qapidoc-856" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for qcow.</p> <div class="section" id="qapidoc-854"> <h5>Members<a class="headerlink" href="#qapidoc-854" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>File name of the backing file if a backing file should be used</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptions</span></code> (optional)</dt> <dd>Encryption options if the image should be encrypted</dd> </dl> </div> <div class="section" id="qapidoc-855"> <h5>Since<a class="headerlink" href="#qapidoc-855" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-859"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevQcow2Version</span></code> (Enum)<a class="headerlink" href="#qapidoc-859" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-857"> <h5>Values<a class="headerlink" href="#qapidoc-857" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">v2</span></code></dt> <dd>The original QCOW2 format as introduced in qemu 0.10 (version 2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">v3</span></code></dt> <dd>The extended QCOW2 format as introduced in qemu 1.1 (version 3)</dd> </dl> </div> <div class="section" id="qapidoc-858"> <h5>Since<a class="headerlink" href="#qapidoc-858" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-862"> <h4><code class="docutils literal notranslate"><span class="pre">Qcow2CompressionType</span></code> (Enum)<a class="headerlink" href="#qapidoc-862" title="Permalink to this headline">¶</a></h4> <p>Compression type used in qcow2 image file</p> <div class="section" id="qapidoc-860"> <h5>Values<a class="headerlink" href="#qapidoc-860" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">zlib</span></code></dt> <dd>zlib compression, see <<a class="reference external" href="http://zlib.net/">http://zlib.net/</a>></dd> <dt><code class="docutils literal notranslate"><span class="pre">zstd</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_ZSTD</span></code>)</dt> <dd>zstd compression, see <<a class="reference external" href="http://github.com/facebook/zstd">http://github.com/facebook/zstd</a>></dd> </dl> </div> <div class="section" id="qapidoc-861"> <h5>Since<a class="headerlink" href="#qapidoc-861" title="Permalink to this headline">¶</a></h5> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-865"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQcow2</span></code> (Object)<a class="headerlink" href="#qapidoc-865" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for qcow2.</p> <div class="section" id="qapidoc-863"> <h5>Members<a class="headerlink" href="#qapidoc-863" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code> (optional)</dt> <dd>Node to use as an external data file in which all guest data is stored so that only metadata remains in the qcow2 file (since: 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-file-raw</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True if the external data file must stay valid as a standalone (read-only) raw image without looking at qcow2 metadata (default: false; since: 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">extended-l2</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True to make the image have extended L2 entries (default: false; since 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">version</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevQcow2Version</span></code> (optional)</dt> <dd>Compatibility level (default: v3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>File name of the backing file if a backing file should be used</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-fmt</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code> (optional)</dt> <dd>Name of the block driver to use for the backing file</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockCreateOptions</span></code> (optional)</dt> <dd>Encryption options if the image should be encrypted</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>qcow2 cluster size in bytes (default: 65536)</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocation</span></code>: <code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (optional)</dt> <dd>Preallocation mode for the new image (default: off; allowed values: off, falloc, full, metadata)</dd> <dt><code class="docutils literal notranslate"><span class="pre">lazy-refcounts</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True if refcounts may be updated lazily (default: off)</dd> <dt><code class="docutils literal notranslate"><span class="pre">refcount-bits</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Width of reference counts in bits (default: 16)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compression-type</span></code>: <code class="docutils literal notranslate"><span class="pre">Qcow2CompressionType</span></code> (optional)</dt> <dd>The image cluster compression method (default: zlib, since 5.1)</dd> </dl> </div> <div class="section" id="qapidoc-864"> <h5>Since<a class="headerlink" href="#qapidoc-864" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-868"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQed</span></code> (Object)<a class="headerlink" href="#qapidoc-868" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for qed.</p> <div class="section" id="qapidoc-866"> <h5>Members<a class="headerlink" href="#qapidoc-866" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>File name of the backing file if a backing file should be used</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-fmt</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code> (optional)</dt> <dd>Name of the block driver to use for the backing file</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Cluster size in bytes (default: 65536)</dd> <dt><code class="docutils literal notranslate"><span class="pre">table-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>L1/L2 table size (in clusters)</dd> </dl> </div> <div class="section" id="qapidoc-867"> <h5>Since<a class="headerlink" href="#qapidoc-867" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-871"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsRbd</span></code> (Object)<a class="headerlink" href="#qapidoc-871" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for rbd/Ceph.</p> <div class="section" id="qapidoc-869"> <h5>Members<a class="headerlink" href="#qapidoc-869" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">location</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsRbd</span></code></dt> <dd>Where to store the new image file. This location cannot point to a snapshot.</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">cluster-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>RBD object size</dd> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">RbdEncryptionCreateOptions</span></code> (optional)</dt> <dd>Image encryption options. (Since 6.1)</dd> </dl> </div> <div class="section" id="qapidoc-870"> <h5>Since<a class="headerlink" href="#qapidoc-870" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-874"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevVmdkSubformat</span></code> (Enum)<a class="headerlink" href="#qapidoc-874" title="Permalink to this headline">¶</a></h4> <p>Subformat options for VMDK images</p> <div class="section" id="qapidoc-872"> <h5>Values<a class="headerlink" href="#qapidoc-872" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">monolithicSparse</span></code></dt> <dd>Single file image with sparse cluster allocation</dd> <dt><code class="docutils literal notranslate"><span class="pre">monolithicFlat</span></code></dt> <dd>Single flat data image and a descriptor file</dd> <dt><code class="docutils literal notranslate"><span class="pre">twoGbMaxExtentSparse</span></code></dt> <dd>Data is split into 2GB (per virtual LBA) sparse extent files, in addition to a descriptor file</dd> <dt><code class="docutils literal notranslate"><span class="pre">twoGbMaxExtentFlat</span></code></dt> <dd>Data is split into 2GB (per virtual LBA) flat extent files, in addition to a descriptor file</dd> <dt><code class="docutils literal notranslate"><span class="pre">streamOptimized</span></code></dt> <dd>Single file image sparse cluster allocation, optimized for streaming over network.</dd> </dl> </div> <div class="section" id="qapidoc-873"> <h5>Since<a class="headerlink" href="#qapidoc-873" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-877"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevVmdkAdapterType</span></code> (Enum)<a class="headerlink" href="#qapidoc-877" title="Permalink to this headline">¶</a></h4> <p>Adapter type info for VMDK images</p> <div class="section" id="qapidoc-875"> <h5>Values<a class="headerlink" href="#qapidoc-875" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ide</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">buslogic</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">lsilogic</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">legacyESX</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-876"> <h5>Since<a class="headerlink" href="#qapidoc-876" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-880"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVmdk</span></code> (Object)<a class="headerlink" href="#qapidoc-880" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for VMDK.</p> <div class="section" id="qapidoc-878"> <h5>Members<a class="headerlink" href="#qapidoc-878" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Where to store the new image file. This refers to the image file for monolithcSparse and streamOptimized format, or the descriptor file for other formats.</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">extents</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BlockdevRef</span></code> (optional)</dt> <dd>Where to store the data extents. Required for monolithcFlat, twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For monolithicFlat, only one entry is required; for twoGbMaxExtent* formats, the number of entries required is calculated as extent_number = virtual_size / 2GB. Providing more extents than will be used is an error.</dd> <dt><code class="docutils literal notranslate"><span class="pre">subformat</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevVmdkSubformat</span></code> (optional)</dt> <dd>The subformat of the VMDK image. Default: “monolithicSparse”.</dd> <dt><code class="docutils literal notranslate"><span class="pre">backing-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The path of backing file. Default: no backing file is used.</dd> <dt><code class="docutils literal notranslate"><span class="pre">adapter-type</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevVmdkAdapterType</span></code> (optional)</dt> <dd>The adapter type used to fill in the descriptor. Default: ide.</dd> <dt><code class="docutils literal notranslate"><span class="pre">hwversion</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Hardware version. The meaningful options are “4” or “6”. Default: “4”.</dd> <dt><code class="docutils literal notranslate"><span class="pre">toolsversion</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>VMware guest tools version. Default: “2147483647” (Since 6.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">zeroed-grain</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Whether to enable zeroed-grain feature for sparse subformats. Default: false.</dd> </dl> </div> <div class="section" id="qapidoc-879"> <h5>Since<a class="headerlink" href="#qapidoc-879" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-883"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsSsh</span></code> (Object)<a class="headerlink" href="#qapidoc-883" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for SSH.</p> <div class="section" id="qapidoc-881"> <h5>Members<a class="headerlink" href="#qapidoc-881" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">location</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevOptionsSsh</span></code></dt> <dd>Where to store the new image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> </dl> </div> <div class="section" id="qapidoc-882"> <h5>Since<a class="headerlink" href="#qapidoc-882" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-886"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVdi</span></code> (Object)<a class="headerlink" href="#qapidoc-886" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for VDI.</p> <div class="section" id="qapidoc-884"> <h5>Members<a class="headerlink" href="#qapidoc-884" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">preallocation</span></code>: <code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (optional)</dt> <dd>Preallocation mode for the new image (default: off; allowed values: off, metadata)</dd> </dl> </div> <div class="section" id="qapidoc-885"> <h5>Since<a class="headerlink" href="#qapidoc-885" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-889"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevVhdxSubformat</span></code> (Enum)<a class="headerlink" href="#qapidoc-889" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-887"> <h5>Values<a class="headerlink" href="#qapidoc-887" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></dt> <dd>Growing image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">fixed</span></code></dt> <dd>Preallocated fixed-size image file</dd> </dl> </div> <div class="section" id="qapidoc-888"> <h5>Since<a class="headerlink" href="#qapidoc-888" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-892"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVhdx</span></code> (Object)<a class="headerlink" href="#qapidoc-892" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for vhdx.</p> <div class="section" id="qapidoc-890"> <h5>Members<a class="headerlink" href="#qapidoc-890" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">log-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Log size in bytes, must be a multiple of 1 MB (default: 1 MB)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Block size in bytes, must be a multiple of 1 MB and not larger than 256 MB (default: automatically choose a block size depending on the image size)</dd> <dt><code class="docutils literal notranslate"><span class="pre">subformat</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevVhdxSubformat</span></code> (optional)</dt> <dd>vhdx subformat (default: dynamic)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-state-zero</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Force use of payload blocks of type ‘ZERO’. Non-standard, but default. Do not set to ‘off’ when using ‘qemu-img convert’ with subformat=dynamic.</dd> </dl> </div> <div class="section" id="qapidoc-891"> <h5>Since<a class="headerlink" href="#qapidoc-891" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-895"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevVpcSubformat</span></code> (Enum)<a class="headerlink" href="#qapidoc-895" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-893"> <h5>Values<a class="headerlink" href="#qapidoc-893" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></dt> <dd>Growing image file</dd> <dt><code class="docutils literal notranslate"><span class="pre">fixed</span></code></dt> <dd>Preallocated fixed-size image file</dd> </dl> </div> <div class="section" id="qapidoc-894"> <h5>Since<a class="headerlink" href="#qapidoc-894" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-898"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVpc</span></code> (Object)<a class="headerlink" href="#qapidoc-898" title="Permalink to this headline">¶</a></h4> <p>Driver specific image creation options for vpc (VHD).</p> <div class="section" id="qapidoc-896"> <h5>Members<a class="headerlink" href="#qapidoc-896" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevRef</span></code></dt> <dd>Node to create the image format on</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Size of the virtual disk in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">subformat</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevVpcSubformat</span></code> (optional)</dt> <dd>vhdx subformat (default: dynamic)</dd> <dt><code class="docutils literal notranslate"><span class="pre">force-size</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Force use of the exact byte size instead of rounding to the next size that can be represented in CHS geometry (default: false)</dd> </dl> </div> <div class="section" id="qapidoc-897"> <h5>Since<a class="headerlink" href="#qapidoc-897" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-901"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-901" title="Permalink to this headline">¶</a></h4> <p>Options for creating an image format on a given node.</p> <div class="section" id="qapidoc-899"> <h5>Members<a class="headerlink" href="#qapidoc-899" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code></dt> <dd>block driver to create the image format</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsFile</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"file"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsGluster</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"gluster"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsNfs</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"nfs"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsParallels</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"parallels"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQcow</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQcow2</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow2"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsQed</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qed"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsRbd</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"rbd"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsSsh</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"ssh"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVdi</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vdi"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVhdx</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vhdx"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVmdk</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vmdk"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptionsVpc</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"vpc"</span></code></dl> </div> <div class="section" id="qapidoc-900"> <h5>Since<a class="headerlink" href="#qapidoc-900" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-904"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-create</span></code> (Command)<a class="headerlink" href="#qapidoc-904" title="Permalink to this headline">¶</a></h4> <p>Starts a job to create an image format on a given node. The job is automatically finalized, but a manual job-dismiss is required.</p> <div class="section" id="qapidoc-902"> <h5>Arguments<a class="headerlink" href="#qapidoc-902" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Identifier for the newly created job.</dd> <dt><code class="docutils literal notranslate"><span class="pre">options</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevCreateOptions</span></code></dt> <dd>Options for the image creation.</dd> </dl> </div> <div class="section" id="qapidoc-903"> <h5>Since<a class="headerlink" href="#qapidoc-903" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-907"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptionsLUKS</span></code> (Object)<a class="headerlink" href="#qapidoc-907" title="Permalink to this headline">¶</a></h4> <p>Driver specific image amend options for LUKS.</p> <div class="section" id="qapidoc-905"> <h5>Members<a class="headerlink" href="#qapidoc-905" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptionsLUKS</span></code></dl> </div> <div class="section" id="qapidoc-906"> <h5>Since<a class="headerlink" href="#qapidoc-906" title="Permalink to this headline">¶</a></h5> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-910"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptionsQcow2</span></code> (Object)<a class="headerlink" href="#qapidoc-910" title="Permalink to this headline">¶</a></h4> <p>Driver specific image amend options for qcow2. For now, only encryption options can be amended</p> <p><code class="docutils literal notranslate"><span class="pre">encrypt</span></code> Encryption options to be amended</p> <div class="section" id="qapidoc-908"> <h5>Members<a class="headerlink" href="#qapidoc-908" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">encrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">QCryptoBlockAmendOptions</span></code> (optional)</dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-909"> <h5>Since<a class="headerlink" href="#qapidoc-909" title="Permalink to this headline">¶</a></h5> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-913"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-913" title="Permalink to this headline">¶</a></h4> <p>Options for amending an image format</p> <div class="section" id="qapidoc-911"> <h5>Members<a class="headerlink" href="#qapidoc-911" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevDriver</span></code></dt> <dd>Block driver of the node to amend.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptionsLUKS</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"luks"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptionsQcow2</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcow2"</span></code></dl> </div> <div class="section" id="qapidoc-912"> <h5>Since<a class="headerlink" href="#qapidoc-912" title="Permalink to this headline">¶</a></h5> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-917"> <h4><code class="docutils literal notranslate"><span class="pre">x-blockdev-amend</span></code> (Command)<a class="headerlink" href="#qapidoc-917" title="Permalink to this headline">¶</a></h4> <p>Starts a job to amend format specific options of an existing open block device The job is automatically finalized, but a manual job-dismiss is required.</p> <div class="section" id="qapidoc-914"> <h5>Arguments<a class="headerlink" href="#qapidoc-914" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Identifier for the newly created job.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Name of the block node to work on</dd> <dt><code class="docutils literal notranslate"><span class="pre">options</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevAmendOptions</span></code></dt> <dd>Options (driver specific)</dd> <dt><code class="docutils literal notranslate"><span class="pre">force</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Allow unsafe operations, format specific For luks that allows erase of the last active keyslot (permanent loss of data), and replacement of an active keyslot (possible loss of data if IO error happens)</dd> </dl> </div> <div class="section" id="qapidoc-915"> <h5>Features<a class="headerlink" href="#qapidoc-915" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-916"> <h5>Since<a class="headerlink" href="#qapidoc-916" title="Permalink to this headline">¶</a></h5> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-920"> <h4><code class="docutils literal notranslate"><span class="pre">BlockErrorAction</span></code> (Enum)<a class="headerlink" href="#qapidoc-920" title="Permalink to this headline">¶</a></h4> <p>An enumeration of action that has been taken when a DISK I/O occurs</p> <div class="section" id="qapidoc-918"> <h5>Values<a class="headerlink" href="#qapidoc-918" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ignore</span></code></dt> <dd>error has been ignored</dd> <dt><code class="docutils literal notranslate"><span class="pre">report</span></code></dt> <dd>error has been reported to the device</dd> <dt><code class="docutils literal notranslate"><span class="pre">stop</span></code></dt> <dd>error caused VM to be stopped</dd> </dl> </div> <div class="section" id="qapidoc-919"> <h5>Since<a class="headerlink" href="#qapidoc-919" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-925"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_IMAGE_CORRUPTED</span></code> (Event)<a class="headerlink" href="#qapidoc-925" title="Permalink to this headline">¶</a></h4> <p>Emitted when a disk image is being marked corrupt. The image can be identified by its device or node name. The ‘device’ field is always present for compatibility reasons, but it can be empty (“”) if the image does not have a device name associated.</p> <div class="section" id="qapidoc-921"> <h5>Arguments<a class="headerlink" href="#qapidoc-921" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device name. This is always present for compatibility reasons, but it can be empty (“”) if the image does not have a device name associated.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>node name (Since: 2.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">msg</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>informative message for human consumption, such as the kind of corruption being detected. It should not be parsed by machine as it is not guaranteed to be stable</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if the corruption resulted from an image access, this is the host’s access offset into the image</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if the corruption resulted from an image access, this is the access size</dd> <dt><code class="docutils literal notranslate"><span class="pre">fatal</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>if set, the image is marked corrupt and therefore unusable after this event and must be repaired (Since 2.2; before, every BLOCK_IMAGE_CORRUPTED event was fatal)</dd> </dl> </div> <div class="section" id="qapidoc-922"> <h5>Note<a class="headerlink" href="#qapidoc-922" title="Permalink to this headline">¶</a></h5> <p>If action is “stop”, a STOP event will eventually follow the BLOCK_IO_ERROR event.</p> </div> <div class="section" id="qapidoc-923"> <h5>Example<a class="headerlink" href="#qapidoc-923" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_IMAGE_CORRUPTED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide0-hd0"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"msg"</span><span class="p">:</span> <span class="s2">"Prevented active L1 table overwrite"</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">196608</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">65536</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1378126126</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">966463</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-924"> <h5>Since<a class="headerlink" href="#qapidoc-924" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-930"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_IO_ERROR</span></code> (Event)<a class="headerlink" href="#qapidoc-930" title="Permalink to this headline">¶</a></h4> <p>Emitted when a disk I/O error occurs</p> <div class="section" id="qapidoc-926"> <h5>Arguments<a class="headerlink" href="#qapidoc-926" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device name. This is always present for compatibility reasons, but it can be empty (“”) if the image does not have a device name associated.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>node name. Note that errors may be reported for the root node that is directly attached to a guest device rather than for the node where the error occurred. The node name is not present if the drive is empty. (Since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">operation</span></code>: <code class="docutils literal notranslate"><span class="pre">IoOperationType</span></code></dt> <dd>I/O operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockErrorAction</span></code></dt> <dd>action that has been taken</dd> <dt><code class="docutils literal notranslate"><span class="pre">nospace</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if I/O error was caused due to a no-space condition. This key is only present if query-block’s io-status is present, please see query-block documentation for more information (since: 2.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>human readable string describing the error cause. (This field is a debugging aid for humans, it should not be parsed by applications) (since: 2.2)</dd> </dl> </div> <div class="section" id="qapidoc-927"> <h5>Note<a class="headerlink" href="#qapidoc-927" title="Permalink to this headline">¶</a></h5> <p>If action is “stop”, a STOP event will eventually follow the BLOCK_IO_ERROR event</p> </div> <div class="section" id="qapidoc-928"> <h5>Since<a class="headerlink" href="#qapidoc-928" title="Permalink to this headline">¶</a></h5> <p>0.13</p> </div> <div class="section" id="qapidoc-929"> <h5>Example<a class="headerlink" href="#qapidoc-929" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_IO_ERROR"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide0-hd1"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"#block212"</span><span class="p">,</span> <span class="s2">"operation"</span><span class="p">:</span> <span class="s2">"write"</span><span class="p">,</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"stop"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-934"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_COMPLETED</span></code> (Event)<a class="headerlink" href="#qapidoc-934" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block job has completed</p> <div class="section" id="qapidoc-931"> <h5>Arguments<a class="headerlink" href="#qapidoc-931" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">JobType</span></code></dt> <dd>job type</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier. Originally the device name but other values are allowed since QEMU 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">len</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum progress value</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>current progress value. On success this is equal to len. On failure this is less than len</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>rate limit, bytes per second</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>error message. Only present on failure. This field contains a human-readable error message. There are no semantics other than that streaming has failed and clients should not try to interpret the error string</dd> </dl> </div> <div class="section" id="qapidoc-932"> <h5>Since<a class="headerlink" href="#qapidoc-932" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-933"> <h5>Example<a class="headerlink" href="#qapidoc-933" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_JOB_COMPLETED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"stream"</span><span class="p">,</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"virtio-disk0"</span><span class="p">,</span> <span class="s2">"len"</span><span class="p">:</span> <span class="mi">10737418240</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">10737418240</span><span class="p">,</span> <span class="s2">"speed"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267061043</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">959568</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-938"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_CANCELLED</span></code> (Event)<a class="headerlink" href="#qapidoc-938" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block job has been cancelled</p> <div class="section" id="qapidoc-935"> <h5>Arguments<a class="headerlink" href="#qapidoc-935" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">JobType</span></code></dt> <dd>job type</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier. Originally the device name but other values are allowed since QEMU 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">len</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum progress value</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>current progress value. On success this is equal to len. On failure this is less than len</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>rate limit, bytes per second</dd> </dl> </div> <div class="section" id="qapidoc-936"> <h5>Since<a class="headerlink" href="#qapidoc-936" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-937"> <h5>Example<a class="headerlink" href="#qapidoc-937" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_JOB_CANCELLED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"stream"</span><span class="p">,</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"virtio-disk0"</span><span class="p">,</span> <span class="s2">"len"</span><span class="p">:</span> <span class="mi">10737418240</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">134217728</span><span class="p">,</span> <span class="s2">"speed"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267061043</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">959568</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-942"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_ERROR</span></code> (Event)<a class="headerlink" href="#qapidoc-942" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block job encounters an error</p> <div class="section" id="qapidoc-939"> <h5>Arguments<a class="headerlink" href="#qapidoc-939" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier. Originally the device name but other values are allowed since QEMU 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">operation</span></code>: <code class="docutils literal notranslate"><span class="pre">IoOperationType</span></code></dt> <dd>I/O operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockErrorAction</span></code></dt> <dd>action that has been taken</dd> </dl> </div> <div class="section" id="qapidoc-940"> <h5>Since<a class="headerlink" href="#qapidoc-940" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> <div class="section" id="qapidoc-941"> <h5>Example<a class="headerlink" href="#qapidoc-941" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_JOB_ERROR"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide0-hd1"</span><span class="p">,</span> <span class="s2">"operation"</span><span class="p">:</span> <span class="s2">"write"</span><span class="p">,</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"stop"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-947"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_READY</span></code> (Event)<a class="headerlink" href="#qapidoc-947" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block job is ready to complete</p> <div class="section" id="qapidoc-943"> <h5>Arguments<a class="headerlink" href="#qapidoc-943" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">JobType</span></code></dt> <dd>job type</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier. Originally the device name but other values are allowed since QEMU 2.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">len</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum progress value</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>current progress value. On success this is equal to len. On failure this is less than len</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>rate limit, bytes per second</dd> </dl> </div> <div class="section" id="qapidoc-944"> <h5>Note<a class="headerlink" href="#qapidoc-944" title="Permalink to this headline">¶</a></h5> <p>The “ready to complete” status is always reset by a <code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_ERROR</span></code> event</p> </div> <div class="section" id="qapidoc-945"> <h5>Since<a class="headerlink" href="#qapidoc-945" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> <div class="section" id="qapidoc-946"> <h5>Example<a class="headerlink" href="#qapidoc-946" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_JOB_READY"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mirror"</span><span class="p">,</span> <span class="s2">"speed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"len"</span><span class="p">:</span> <span class="mi">2097152</span><span class="p">,</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">2097152</span> <span class="p">}</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-951"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_JOB_PENDING</span></code> (Event)<a class="headerlink" href="#qapidoc-951" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block job is awaiting explicit authorization to finalize graph changes via <code class="docutils literal notranslate"><span class="pre">block-job-finalize</span></code>. If this job is part of a transaction, it will not emit this event until the transaction has converged first.</p> <div class="section" id="qapidoc-948"> <h5>Arguments<a class="headerlink" href="#qapidoc-948" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">JobType</span></code></dt> <dd>job type</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The job identifier.</dd> </dl> </div> <div class="section" id="qapidoc-949"> <h5>Since<a class="headerlink" href="#qapidoc-949" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> <div class="section" id="qapidoc-950"> <h5>Example<a class="headerlink" href="#qapidoc-950" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BLOCK_JOB_WAITING"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"mirror"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-954"> <h4><code class="docutils literal notranslate"><span class="pre">PreallocMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-954" title="Permalink to this headline">¶</a></h4> <p>Preallocation mode of QEMU image file</p> <div class="section" id="qapidoc-952"> <h5>Values<a class="headerlink" href="#qapidoc-952" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>no preallocation</dd> <dt><code class="docutils literal notranslate"><span class="pre">metadata</span></code></dt> <dd>preallocate only for metadata</dd> <dt><code class="docutils literal notranslate"><span class="pre">falloc</span></code></dt> <dd>like <code class="docutils literal notranslate"><span class="pre">full</span></code> preallocation but allocate disk space by posix_fallocate() rather than writing data.</dd> <dt><code class="docutils literal notranslate"><span class="pre">full</span></code></dt> <dd>preallocate all data by writing it to the device to ensure disk space is really available. This data may or may not be zero, depending on the image format and storage. <code class="docutils literal notranslate"><span class="pre">full</span></code> preallocation also sets up metadata correctly.</dd> </dl> </div> <div class="section" id="qapidoc-953"> <h5>Since<a class="headerlink" href="#qapidoc-953" title="Permalink to this headline">¶</a></h5> <p>2.2</p> </div> </div> <div class="section" id="qapidoc-957"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_WRITE_THRESHOLD</span></code> (Event)<a class="headerlink" href="#qapidoc-957" title="Permalink to this headline">¶</a></h4> <p>Emitted when writes on block device reaches or exceeds the configured write threshold. For thin-provisioned devices, this means the device should be extended to avoid pausing for disk exhaustion. The event is one shot. Once triggered, it needs to be re-registered with another block-set-write-threshold command.</p> <div class="section" id="qapidoc-955"> <h5>Arguments<a class="headerlink" href="#qapidoc-955" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>graph node name on which the threshold was exceeded.</dd> <dt><code class="docutils literal notranslate"><span class="pre">amount-exceeded</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of data which exceeded the threshold, in bytes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>last configured threshold, in bytes.</dd> </dl> </div> <div class="section" id="qapidoc-956"> <h5>Since<a class="headerlink" href="#qapidoc-956" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-961"> <h4><code class="docutils literal notranslate"><span class="pre">block-set-write-threshold</span></code> (Command)<a class="headerlink" href="#qapidoc-961" title="Permalink to this headline">¶</a></h4> <p>Change the write threshold for a block drive. An event will be delivered if a write to this block drive crosses the configured threshold. The threshold is an offset, thus must be non-negative. Default is no write threshold. Setting the threshold to zero disables it.</p> <p>This is useful to transparently resize thin-provisioned drives without the guest OS noticing.</p> <div class="section" id="qapidoc-958"> <h5>Arguments<a class="headerlink" href="#qapidoc-958" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>graph node name on which the threshold must be set.</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>configured threshold for the block device, bytes. Use 0 to disable the threshold.</dd> </dl> </div> <div class="section" id="qapidoc-959"> <h5>Since<a class="headerlink" href="#qapidoc-959" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-960"> <h5>Example<a class="headerlink" href="#qapidoc-960" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-set-write-threshold"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"mydev"</span><span class="p">,</span> <span class="s2">"write-threshold"</span><span class="p">:</span> <span class="mi">17179869184</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-966"> <h4><code class="docutils literal notranslate"><span class="pre">x-blockdev-change</span></code> (Command)<a class="headerlink" href="#qapidoc-966" title="Permalink to this headline">¶</a></h4> <p>Dynamically reconfigure the block driver state graph. It can be used to add, remove, insert or replace a graph node. Currently only the Quorum driver implements this feature to add or remove its child. This is useful to fix a broken quorum child.</p> <p>If <code class="docutils literal notranslate"><span class="pre">node</span></code> is specified, it will be inserted under <code class="docutils literal notranslate"><span class="pre">parent</span></code>. <code class="docutils literal notranslate"><span class="pre">child</span></code> may not be specified in this case. If both <code class="docutils literal notranslate"><span class="pre">parent</span></code> and <code class="docutils literal notranslate"><span class="pre">child</span></code> are specified but <code class="docutils literal notranslate"><span class="pre">node</span></code> is not, <code class="docutils literal notranslate"><span class="pre">child</span></code> will be detached from <code class="docutils literal notranslate"><span class="pre">parent</span></code>.</p> <div class="section" id="qapidoc-962"> <h5>Arguments<a class="headerlink" href="#qapidoc-962" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">parent</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the id or name of the parent node.</dd> <dt><code class="docutils literal notranslate"><span class="pre">child</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of a child under the given parent node.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the node that will be added.</dd> </dl> </div> <div class="section" id="qapidoc-963"> <h5>Features<a class="headerlink" href="#qapidoc-963" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd><p class="first">This command is experimental, and its API is not stable. It does not support all kinds of operations, all kinds of children, nor all block drivers.</p> <p>FIXME Removing children from a quorum node means introducing gaps in the child indices. This cannot be represented in the ‘children’ list of BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename().</p> <p class="last">Warning: The data in a new quorum child MUST be consistent with that of the rest of the array.</p> </dd> </dl> </div> <div class="section" id="qapidoc-964"> <h5>Since<a class="headerlink" href="#qapidoc-964" title="Permalink to this headline">¶</a></h5> <p>2.7</p> </div> <div class="section" id="qapidoc-965"> <h5>Example<a class="headerlink" href="#qapidoc-965" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Add</span> <span class="n">a</span> <span class="n">new</span> <span class="n">node</span> <span class="n">to</span> <span class="n">a</span> <span class="n">quorum</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"raw"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"new_node"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"test.raw"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-blockdev-change"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"parent"</span><span class="p">:</span> <span class="s2">"disk1"</span><span class="p">,</span> <span class="s2">"node"</span><span class="p">:</span> <span class="s2">"new_node"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Delete</span> <span class="n">a</span> <span class="n">quorum</span><span class="s1">'s node</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-blockdev-change"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"parent"</span><span class="p">:</span> <span class="s2">"disk1"</span><span class="p">,</span> <span class="s2">"child"</span><span class="p">:</span> <span class="s2">"children.1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-971"> <h4><code class="docutils literal notranslate"><span class="pre">x-blockdev-set-iothread</span></code> (Command)<a class="headerlink" href="#qapidoc-971" title="Permalink to this headline">¶</a></h4> <p>Move <code class="docutils literal notranslate"><span class="pre">node</span></code> and its children into the <code class="docutils literal notranslate"><span class="pre">iothread</span></code>. If <code class="docutils literal notranslate"><span class="pre">iothread</span></code> is null then move <code class="docutils literal notranslate"><span class="pre">node</span></code> and its children into the main loop.</p> <p>The node must not be attached to a BlockBackend.</p> <div class="section" id="qapidoc-967"> <h5>Arguments<a class="headerlink" href="#qapidoc-967" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the block driver node</dd> <dt><code class="docutils literal notranslate"><span class="pre">iothread</span></code>: <code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code></dt> <dd>the name of the IOThread object or null for the main loop</dd> <dt><code class="docutils literal notranslate"><span class="pre">force</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true if the node and its children should be moved when a BlockBackend is already attached</dd> </dl> </div> <div class="section" id="qapidoc-968"> <h5>Features<a class="headerlink" href="#qapidoc-968" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is experimental and intended for test cases that need control over IOThreads only.</dd> </dl> </div> <div class="section" id="qapidoc-969"> <h5>Since<a class="headerlink" href="#qapidoc-969" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> <div class="section" id="qapidoc-970"> <h5>Example<a class="headerlink" href="#qapidoc-970" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Move</span> <span class="n">a</span> <span class="n">node</span> <span class="n">into</span> <span class="n">an</span> <span class="n">IOThread</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-blockdev-set-iothread"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"disk1"</span><span class="p">,</span> <span class="s2">"iothread"</span><span class="p">:</span> <span class="s2">"iothread0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Move</span> <span class="n">a</span> <span class="n">node</span> <span class="n">into</span> <span class="n">the</span> <span class="n">main</span> <span class="n">loop</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-blockdev-set-iothread"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"disk1"</span><span class="p">,</span> <span class="s2">"iothread"</span><span class="p">:</span> <span class="n">null</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-974"> <h4><code class="docutils literal notranslate"><span class="pre">QuorumOpType</span></code> (Enum)<a class="headerlink" href="#qapidoc-974" title="Permalink to this headline">¶</a></h4> <p>An enumeration of the quorum operation types</p> <div class="section" id="qapidoc-972"> <h5>Values<a class="headerlink" href="#qapidoc-972" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">read</span></code></dt> <dd>read operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">write</span></code></dt> <dd>write operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">flush</span></code></dt> <dd>flush operation</dd> </dl> </div> <div class="section" id="qapidoc-973"> <h5>Since<a class="headerlink" href="#qapidoc-973" title="Permalink to this headline">¶</a></h5> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-979"> <h4><code class="docutils literal notranslate"><span class="pre">QUORUM_FAILURE</span></code> (Event)<a class="headerlink" href="#qapidoc-979" title="Permalink to this headline">¶</a></h4> <p>Emitted by the Quorum block driver if it fails to establish a quorum</p> <div class="section" id="qapidoc-975"> <h5>Arguments<a class="headerlink" href="#qapidoc-975" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">reference</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device name if defined else node name</dd> <dt><code class="docutils literal notranslate"><span class="pre">sector-num</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of the first sector of the failed read operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">sectors-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>failed read operation sector count</dd> </dl> </div> <div class="section" id="qapidoc-976"> <h5>Note<a class="headerlink" href="#qapidoc-976" title="Permalink to this headline">¶</a></h5> <p>This event is rate-limited.</p> </div> <div class="section" id="qapidoc-977"> <h5>Since<a class="headerlink" href="#qapidoc-977" title="Permalink to this headline">¶</a></h5> <p>2.0</p> </div> <div class="section" id="qapidoc-978"> <h5>Example<a class="headerlink" href="#qapidoc-978" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"QUORUM_FAILURE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"reference"</span><span class="p">:</span> <span class="s2">"usr1"</span><span class="p">,</span> <span class="s2">"sector-num"</span><span class="p">:</span> <span class="mi">345435</span><span class="p">,</span> <span class="s2">"sectors-count"</span><span class="p">:</span> <span class="mi">5</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1344522075</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">745528</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-984"> <h4><code class="docutils literal notranslate"><span class="pre">QUORUM_REPORT_BAD</span></code> (Event)<a class="headerlink" href="#qapidoc-984" title="Permalink to this headline">¶</a></h4> <p>Emitted to report a corruption of a Quorum file</p> <div class="section" id="qapidoc-980"> <h5>Arguments<a class="headerlink" href="#qapidoc-980" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">QuorumOpType</span></code></dt> <dd>quorum operation type (Since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>error message. Only present on failure. This field contains a human-readable error message. There are no semantics other than that the block layer reported an error and clients should not try to interpret the error string.</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the graph node name of the block driver state</dd> <dt><code class="docutils literal notranslate"><span class="pre">sector-num</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of the first sector of the failed read operation</dd> <dt><code class="docutils literal notranslate"><span class="pre">sectors-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>failed read operation sector count</dd> </dl> </div> <div class="section" id="qapidoc-981"> <h5>Note<a class="headerlink" href="#qapidoc-981" title="Permalink to this headline">¶</a></h5> <p>This event is rate-limited.</p> </div> <div class="section" id="qapidoc-982"> <h5>Since<a class="headerlink" href="#qapidoc-982" title="Permalink to this headline">¶</a></h5> <p>2.0</p> </div> <div class="section" id="qapidoc-983"> <h5>Example<a class="headerlink" href="#qapidoc-983" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Read</span> <span class="n">operation</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"QUORUM_REPORT_BAD"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"sector-num"</span><span class="p">:</span> <span class="mi">345435</span><span class="p">,</span> <span class="s2">"sectors-count"</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"read"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1344522075</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">745528</span> <span class="p">}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Flush</span> <span class="n">operation</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"QUORUM_REPORT_BAD"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"sector-num"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"sectors-count"</span><span class="p">:</span> <span class="mi">2097120</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"flush"</span><span class="p">,</span> <span class="s2">"error"</span><span class="p">:</span> <span class="s2">"Broken pipe"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1456406829</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">291763</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-988"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternal</span></code> (Object)<a class="headerlink" href="#qapidoc-988" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-985"> <h5>Members<a class="headerlink" href="#qapidoc-985" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of a root node to generate the snapshot from</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the internal snapshot to be created</dd> </dl> </div> <div class="section" id="qapidoc-986"> <h5>Notes<a class="headerlink" href="#qapidoc-986" title="Permalink to this headline">¶</a></h5> <p>In transaction, if <code class="docutils literal notranslate"><span class="pre">name</span></code> is empty, or any snapshot matching <code class="docutils literal notranslate"><span class="pre">name</span></code> exists, the operation will fail. Only some image formats support it, for example, qcow2, and rbd.</p> </div> <div class="section" id="qapidoc-987"> <h5>Since<a class="headerlink" href="#qapidoc-987" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-992"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot-internal-sync</span></code> (Command)<a class="headerlink" href="#qapidoc-992" title="Permalink to this headline">¶</a></h4> <p>Synchronously take an internal snapshot of a block device, when the format of the image used supports it. If the name is an empty string, or a snapshot with name already exists, the operation will fail.</p> <p>For the arguments, see the documentation of BlockdevSnapshotInternal.</p> <div class="section" id="qapidoc-989"> <h5>Returns<a class="headerlink" href="#qapidoc-989" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, GenericError</li> <li>If any snapshot matching <code class="docutils literal notranslate"><span class="pre">name</span></code> exists, or <code class="docutils literal notranslate"><span class="pre">name</span></code> is empty, GenericError</li> <li>If the format of the image used does not support it, BlockFormatFeatureNotSupported</li> </ul> </div> <div class="section" id="qapidoc-990"> <h5>Since<a class="headerlink" href="#qapidoc-990" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> <div class="section" id="qapidoc-991"> <h5>Example<a class="headerlink" href="#qapidoc-991" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-internal-sync"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-997"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot-delete-internal-sync</span></code> (Command)<a class="headerlink" href="#qapidoc-997" title="Permalink to this headline">¶</a></h4> <p>Synchronously delete an internal snapshot of a block device, when the format of the image used support it. The snapshot is identified by name or id or both. One of the name or id is required. Return SnapshotInfo for the successfully deleted snapshot.</p> <div class="section" id="qapidoc-993"> <h5>Arguments<a class="headerlink" href="#qapidoc-993" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name or node-name of a root node to delete the snapshot from</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>optional the snapshot’s ID to be deleted</dd> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>optional the snapshot’s name to be deleted</dd> </dl> </div> <div class="section" id="qapidoc-994"> <h5>Returns<a class="headerlink" href="#qapidoc-994" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>SnapshotInfo on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, GenericError</li> <li>If snapshot not found, GenericError</li> <li>If the format of the image used does not support it, BlockFormatFeatureNotSupported</li> <li>If <code class="docutils literal notranslate"><span class="pre">id</span></code> and <code class="docutils literal notranslate"><span class="pre">name</span></code> are both not specified, GenericError</li> </ul> </div> <div class="section" id="qapidoc-995"> <h5>Since<a class="headerlink" href="#qapidoc-995" title="Permalink to this headline">¶</a></h5> <p>1.7</p> </div> <div class="section" id="qapidoc-996"> <h5>Example<a class="headerlink" href="#qapidoc-996" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-delete-internal-sync"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot0"</span><span class="p">,</span> <span class="s2">"vm-state-size"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"date-sec"</span><span class="p">:</span> <span class="mi">1000012</span><span class="p">,</span> <span class="s2">"date-nsec"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> <span class="s2">"vm-clock-sec"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span> <span class="s2">"vm-clock-nsec"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span> <span class="s2">"icount"</span><span class="p">:</span> <span class="mi">220414</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-998"> <h3><a class="toc-backref" href="#id97">Additional block stuff (VM related)</a><a class="headerlink" href="#qapidoc-998" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1001"> <h4><code class="docutils literal notranslate"><span class="pre">BiosAtaTranslation</span></code> (Enum)<a class="headerlink" href="#qapidoc-1001" title="Permalink to this headline">¶</a></h4> <p>Policy that BIOS should use to interpret cylinder/head/sector addresses. Note that Bochs BIOS and SeaBIOS will not actually translate logical CHS to physical; instead, they will use logical block addressing.</p> <div class="section" id="qapidoc-999"> <h5>Values<a class="headerlink" href="#qapidoc-999" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>If cylinder/heads/sizes are passed, choose between none and LBA depending on the size of the disk. If they are not passed, choose none if QEMU can guess that the disk had 16 or fewer heads, large if QEMU can guess that the disk had 131072 or fewer tracks across all heads (i.e. cylinders*heads<131072), otherwise LBA.</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>The physical disk geometry is equal to the logical geometry.</dd> <dt><code class="docutils literal notranslate"><span class="pre">lba</span></code></dt> <dd>Assume 63 sectors per track and one of 16, 32, 64, 128 or 255 heads (if fewer than 255 are enough to cover the whole disk with 1024 cylinders/head). The number of cylinders/head is then computed based on the number of sectors and heads.</dd> <dt><code class="docutils literal notranslate"><span class="pre">large</span></code></dt> <dd>The number of cylinders per head is scaled down to 1024 by correspondingly scaling up the number of heads.</dd> <dt><code class="docutils literal notranslate"><span class="pre">rechs</span></code></dt> <dd>Same as <code class="docutils literal notranslate"><span class="pre">large</span></code>, but first convert a 16-head geometry to 15-head, by proportionally scaling up the number of cylinders/head.</dd> </dl> </div> <div class="section" id="qapidoc-1000"> <h5>Since<a class="headerlink" href="#qapidoc-1000" title="Permalink to this headline">¶</a></h5> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1004"> <h4><code class="docutils literal notranslate"><span class="pre">FloppyDriveType</span></code> (Enum)<a class="headerlink" href="#qapidoc-1004" title="Permalink to this headline">¶</a></h4> <p>Type of Floppy drive to be emulated by the Floppy Disk Controller.</p> <div class="section" id="qapidoc-1002"> <h5>Values<a class="headerlink" href="#qapidoc-1002" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">144</span></code></dt> <dd>1.44MB 3.5” drive</dd> <dt><code class="docutils literal notranslate"><span class="pre">288</span></code></dt> <dd>2.88MB 3.5” drive</dd> <dt><code class="docutils literal notranslate"><span class="pre">120</span></code></dt> <dd>1.2MB 5.25” drive</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>No drive connected</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>Automatically determined by inserted media at boot</dd> </dl> </div> <div class="section" id="qapidoc-1003"> <h5>Since<a class="headerlink" href="#qapidoc-1003" title="Permalink to this headline">¶</a></h5> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-1007"> <h4><code class="docutils literal notranslate"><span class="pre">PRManagerInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1007" title="Permalink to this headline">¶</a></h4> <p>Information about a persistent reservation manager</p> <div class="section" id="qapidoc-1005"> <h5>Members<a class="headerlink" href="#qapidoc-1005" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the identifier of the persistent reservation manager</dd> <dt><code class="docutils literal notranslate"><span class="pre">connected</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the persistent reservation manager is connected to the underlying storage or helper</dd> </dl> </div> <div class="section" id="qapidoc-1006"> <h5>Since<a class="headerlink" href="#qapidoc-1006" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-1010"> <h4><code class="docutils literal notranslate"><span class="pre">query-pr-managers</span></code> (Command)<a class="headerlink" href="#qapidoc-1010" title="Permalink to this headline">¶</a></h4> <p>Returns a list of information about each persistent reservation manager.</p> <div class="section" id="qapidoc-1008"> <h5>Returns<a class="headerlink" href="#qapidoc-1008" title="Permalink to this headline">¶</a></h5> <p>a list of <code class="docutils literal notranslate"><span class="pre">PRManagerInfo</span></code> for each persistent reservation manager</p> </div> <div class="section" id="qapidoc-1009"> <h5>Since<a class="headerlink" href="#qapidoc-1009" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-1017"> <h4><code class="docutils literal notranslate"><span class="pre">eject</span></code> (Command)<a class="headerlink" href="#qapidoc-1017" title="Permalink to this headline">¶</a></h4> <p>Ejects the medium from a removable drive.</p> <div class="section" id="qapidoc-1011"> <h5>Arguments<a class="headerlink" href="#qapidoc-1011" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Block device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name or QOM path of the guest device (since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">force</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>If true, eject regardless of whether the drive is locked. If not specified, the default value is false.</dd> </dl> </div> <div class="section" id="qapidoc-1012"> <h5>Features<a class="headerlink" href="#qapidoc-1012" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">device</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">id</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1013"> <h5>Returns<a class="headerlink" href="#qapidoc-1013" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-1014"> <h5>Notes<a class="headerlink" href="#qapidoc-1014" title="Permalink to this headline">¶</a></h5> <p>Ejecting a device with no media results in success</p> </div> <div class="section" id="qapidoc-1015"> <h5>Since<a class="headerlink" href="#qapidoc-1015" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1016"> <h5>Example<a class="headerlink" href="#qapidoc-1016" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"eject"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide1-0-1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1022"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-open-tray</span></code> (Command)<a class="headerlink" href="#qapidoc-1022" title="Permalink to this headline">¶</a></h4> <p>Opens a block device’s tray. If there is a block driver state tree inserted as a medium, it will become inaccessible to the guest (but it will remain associated to the block device, so closing the tray will make it accessible again).</p> <p>If the tray was already open before, this will be a no-op.</p> <p>Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in which no such event will be generated, these include:</p> <ul class="simple"> <li>if the guest has locked the tray, <code class="docutils literal notranslate"><span class="pre">force</span></code> is false and the guest does not respond to the eject request</li> <li>if the BlockBackend denoted by <code class="docutils literal notranslate"><span class="pre">device</span></code> does not have a guest device attached to it</li> <li>if the guest device does not have an actual tray</li> </ul> <div class="section" id="qapidoc-1018"> <h5>Arguments<a class="headerlink" href="#qapidoc-1018" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Block device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name or QOM path of the guest device (since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">force</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if false (the default), an eject request will be sent to the guest if it has locked the tray (and the tray will not be opened immediately); if true, the tray will be opened regardless of whether it is locked</dd> </dl> </div> <div class="section" id="qapidoc-1019"> <h5>Features<a class="headerlink" href="#qapidoc-1019" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">device</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">id</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1020"> <h5>Since<a class="headerlink" href="#qapidoc-1020" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> <div class="section" id="qapidoc-1021"> <h5>Example<a class="headerlink" href="#qapidoc-1021" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-open-tray"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1418751016</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">716996</span> <span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_TRAY_MOVED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"tray-open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1027"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-close-tray</span></code> (Command)<a class="headerlink" href="#qapidoc-1027" title="Permalink to this headline">¶</a></h4> <p>Closes a block device’s tray. If there is a block driver state tree associated with the block device (which is currently ejected), that tree will be loaded as the medium.</p> <p>If the tray was already closed before, this will be a no-op.</p> <div class="section" id="qapidoc-1023"> <h5>Arguments<a class="headerlink" href="#qapidoc-1023" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Block device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name or QOM path of the guest device (since: 2.8)</dd> </dl> </div> <div class="section" id="qapidoc-1024"> <h5>Features<a class="headerlink" href="#qapidoc-1024" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">device</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">id</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1025"> <h5>Since<a class="headerlink" href="#qapidoc-1025" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> <div class="section" id="qapidoc-1026"> <h5>Example<a class="headerlink" href="#qapidoc-1026" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-close-tray"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1418751345</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">272147</span> <span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_TRAY_MOVED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"tray-open"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1031"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-remove-medium</span></code> (Command)<a class="headerlink" href="#qapidoc-1031" title="Permalink to this headline">¶</a></h4> <p>Removes a medium (a block driver state tree) from a block device. That block device’s tray must currently be open (unless there is no attached guest device).</p> <p>If the tray is open and there is no medium inserted, this will be a no-op.</p> <div class="section" id="qapidoc-1028"> <h5>Arguments<a class="headerlink" href="#qapidoc-1028" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name or QOM path of the guest device</dd> </dl> </div> <div class="section" id="qapidoc-1029"> <h5>Since<a class="headerlink" href="#qapidoc-1029" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> <div class="section" id="qapidoc-1030"> <h5>Example<a class="headerlink" href="#qapidoc-1030" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-remove-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"error"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="s2">"GenericError"</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"Tray of device 'ide0-1-0' is not open"</span> <span class="p">}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-open-tray"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1418751627</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">549958</span> <span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_TRAY_MOVED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"tray-open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-remove-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1035"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-insert-medium</span></code> (Command)<a class="headerlink" href="#qapidoc-1035" title="Permalink to this headline">¶</a></h4> <p>Inserts a medium (a block driver state tree) into a block device. That block device’s tray must currently be open (unless there is no attached guest device) and there must be no medium inserted already.</p> <div class="section" id="qapidoc-1032"> <h5>Arguments<a class="headerlink" href="#qapidoc-1032" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name or QOM path of the guest device</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of a node in the block driver state graph</dd> </dl> </div> <div class="section" id="qapidoc-1033"> <h5>Since<a class="headerlink" href="#qapidoc-1033" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> <div class="section" id="qapidoc-1034"> <h5>Example<a class="headerlink" href="#qapidoc-1034" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span><span class="p">,</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"raw"</span><span class="p">,</span> <span class="s2">"file"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"fedora.iso"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-insert-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"node0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1038"> <h4><code class="docutils literal notranslate"><span class="pre">BlockdevChangeReadOnlyMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-1038" title="Permalink to this headline">¶</a></h4> <p>Specifies the new read-only mode of a block device subject to the <code class="docutils literal notranslate"><span class="pre">blockdev-change-medium</span></code> command.</p> <div class="section" id="qapidoc-1036"> <h5>Values<a class="headerlink" href="#qapidoc-1036" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">retain</span></code></dt> <dd>Retains the current read-only mode</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-only</span></code></dt> <dd>Makes the device read-only</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-write</span></code></dt> <dd>Makes the device writable</dd> </dl> </div> <div class="section" id="qapidoc-1037"> <h5>Since<a class="headerlink" href="#qapidoc-1037" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-1043"> <h4><code class="docutils literal notranslate"><span class="pre">blockdev-change-medium</span></code> (Command)<a class="headerlink" href="#qapidoc-1043" title="Permalink to this headline">¶</a></h4> <p>Changes the medium inserted into a block device by ejecting the current medium and loading a new image file which is inserted as the new medium (this command combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-medium and blockdev-close-tray).</p> <div class="section" id="qapidoc-1039"> <h5>Arguments<a class="headerlink" href="#qapidoc-1039" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Block device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name or QOM path of the guest device (since: 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>filename of the new image to be loaded</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>format to open the new image with (defaults to the probed format)</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-only-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevChangeReadOnlyMode</span></code> (optional)</dt> <dd>change the read-only mode of the device; defaults to ‘retain’</dd> </dl> </div> <div class="section" id="qapidoc-1040"> <h5>Features<a class="headerlink" href="#qapidoc-1040" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">device</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">id</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1041"> <h5>Since<a class="headerlink" href="#qapidoc-1041" title="Permalink to this headline">¶</a></h5> <p>2.5</p> </div> <div class="section" id="qapidoc-1042"> <h5>Examples<a class="headerlink" href="#qapidoc-1042" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Change</span> <span class="n">a</span> <span class="n">removable</span> <span class="n">medium</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-change-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/srv/images/Fedora-12-x86_64-DVD.iso"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"raw"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Load</span> <span class="n">a</span> <span class="n">read</span><span class="o">-</span><span class="n">only</span> <span class="n">medium</span> <span class="n">into</span> <span class="n">a</span> <span class="n">writable</span> <span class="n">drive</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-change-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"floppyA"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/srv/images/ro.img"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"raw"</span><span class="p">,</span> <span class="s2">"read-only-mode"</span><span class="p">:</span> <span class="s2">"retain"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"error"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="s2">"GenericError"</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"Could not open '/srv/images/ro.img': Permission denied"</span> <span class="p">}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"blockdev-change-medium"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"floppyA"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/srv/images/ro.img"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"raw"</span><span class="p">,</span> <span class="s2">"read-only-mode"</span><span class="p">:</span> <span class="s2">"read-only"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1047"> <h4><code class="docutils literal notranslate"><span class="pre">DEVICE_TRAY_MOVED</span></code> (Event)<a class="headerlink" href="#qapidoc-1047" title="Permalink to this headline">¶</a></h4> <p>Emitted whenever the tray of a removable device is moved by the guest or by HMP/QMP commands</p> <div class="section" id="qapidoc-1044"> <h5>Arguments<a class="headerlink" href="#qapidoc-1044" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Block device name. This is always present for compatibility reasons, but it can be empty (“”) if the image does not have a device name associated.</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name or QOM path of the guest device (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tray-open</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the tray has been opened or false if it has been closed</dd> </dl> </div> <div class="section" id="qapidoc-1045"> <h5>Since<a class="headerlink" href="#qapidoc-1045" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-1046"> <h5>Example<a class="headerlink" href="#qapidoc-1046" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_TRAY_MOVED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide1-cd0"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[22]"</span><span class="p">,</span> <span class="s2">"tray-open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1051"> <h4><code class="docutils literal notranslate"><span class="pre">PR_MANAGER_STATUS_CHANGED</span></code> (Event)<a class="headerlink" href="#qapidoc-1051" title="Permalink to this headline">¶</a></h4> <p>Emitted whenever the connected status of a persistent reservation manager changes.</p> <div class="section" id="qapidoc-1048"> <h5>Arguments<a class="headerlink" href="#qapidoc-1048" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The id of the PR manager object</dd> <dt><code class="docutils literal notranslate"><span class="pre">connected</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the PR manager is connected to a backend</dd> </dl> </div> <div class="section" id="qapidoc-1049"> <h5>Since<a class="headerlink" href="#qapidoc-1049" title="Permalink to this headline">¶</a></h5> <p>3.0</p> </div> <div class="section" id="qapidoc-1050"> <h5>Example<a class="headerlink" href="#qapidoc-1050" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"PR_MANAGER_STATUS_CHANGED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"pr-helper0"</span><span class="p">,</span> <span class="s2">"connected"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1519840375</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1056"> <h4><code class="docutils literal notranslate"><span class="pre">block_set_io_throttle</span></code> (Command)<a class="headerlink" href="#qapidoc-1056" title="Permalink to this headline">¶</a></h4> <p>Change I/O throttle limits for a block drive.</p> <p>Since QEMU 2.4, each device with I/O limits is member of a throttle group.</p> <p>If two or more devices are members of the same group, the limits will apply to the combined I/O of the whole group in a round-robin fashion. Therefore, setting new I/O limits to a device will affect the whole group.</p> <p>The name of the group can be specified using the ‘group’ parameter. If the parameter is unset, it is assumed to be the current group of that device. If it’s not in any group yet, the name of the device will be used as the name for its group.</p> <p>The ‘group’ parameter can also be used to move a device to a different group. In this case the limits specified in the parameters will be applied to the new group only.</p> <p>I/O limits can be disabled by setting all of them to 0. In this case the device will be removed from its group and the rest of its members will not be affected. The ‘group’ parameter is ignored.</p> <div class="section" id="qapidoc-1052"> <h5>Arguments<a class="headerlink" href="#qapidoc-1052" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockIOThrottle</span></code></dl> </div> <div class="section" id="qapidoc-1053"> <h5>Returns<a class="headerlink" href="#qapidoc-1053" title="Permalink to this headline">¶</a></h5> <ul class="simple"> <li>Nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">device</span></code> is not a valid block device, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-1054"> <h5>Since<a class="headerlink" href="#qapidoc-1054" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-1055"> <h5>Example<a class="headerlink" href="#qapidoc-1055" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block_set_io_throttle"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"virtio-blk-pci0/virtio-backend"</span><span class="p">,</span> <span class="s2">"bps"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_rd"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops"</span><span class="p">:</span> <span class="mi">512</span><span class="p">,</span> <span class="s2">"iops_rd"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max_length"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_size"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block_set_io_throttle"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"ide0-1-0"</span><span class="p">,</span> <span class="s2">"bps"</span><span class="p">:</span> <span class="mi">1000000</span><span class="p">,</span> <span class="s2">"bps_rd"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_rd"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max"</span><span class="p">:</span> <span class="mi">8000000</span><span class="p">,</span> <span class="s2">"bps_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_rd_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"iops_wr_max"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"bps_max_length"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span> <span class="s2">"iops_size"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1064"> <h4><code class="docutils literal notranslate"><span class="pre">block-latency-histogram-set</span></code> (Command)<a class="headerlink" href="#qapidoc-1064" title="Permalink to this headline">¶</a></h4> <p>Manage read, write and flush latency histograms for the device.</p> <p>If only <code class="docutils literal notranslate"><span class="pre">id</span></code> parameter is specified, remove all present latency histograms for the device. Otherwise, add/reset some of (or all) latency histograms.</p> <div class="section" id="qapidoc-1057"> <h5>Arguments<a class="headerlink" href="#qapidoc-1057" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name or QOM path of the guest device.</dd> <dt><code class="docutils literal notranslate"><span class="pre">boundaries</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of interval boundary values (see description in BlockLatencyHistogramInfo definition). If specified, all latency histograms are removed, and empty ones created for all io types with intervals corresponding to <code class="docutils literal notranslate"><span class="pre">boundaries</span></code> (except for io types, for which specific boundaries are set through the following parameters).</dd> <dt><code class="docutils literal notranslate"><span class="pre">boundaries-read</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of interval boundary values for read latency histogram. If specified, old read latency histogram is removed, and empty one created with intervals corresponding to <code class="docutils literal notranslate"><span class="pre">boundaries-read</span></code>. The parameter has higher priority then <code class="docutils literal notranslate"><span class="pre">boundaries</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">boundaries-write</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of interval boundary values for write latency histogram.</dd> <dt><code class="docutils literal notranslate"><span class="pre">boundaries-flush</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of interval boundary values for flush latency histogram.</dd> </dl> </div> <div class="section" id="qapidoc-1058"> <h5>Returns<a class="headerlink" href="#qapidoc-1058" title="Permalink to this headline">¶</a></h5> <p>error if device is not found or any boundary arrays are invalid.</p> </div> <div class="section" id="qapidoc-1059"> <h5>Since<a class="headerlink" href="#qapidoc-1059" title="Permalink to this headline">¶</a></h5> <p>4.0</p> </div> <div class="section" id="qapidoc-1060"> <h5>Example<a class="headerlink" href="#qapidoc-1060" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">new</span> <span class="n">histograms</span> <span class="k">for</span> <span class="nb">all</span> <span class="n">io</span> <span class="n">types</span> <span class="k">with</span> <span class="n">intervals</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">50</span><span class="p">),</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">),</span> <span class="p">[</span><span class="mi">100</span><span class="p">,</span> <span class="o">+</span><span class="n">inf</span><span class="p">):</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-latency-histogram-set"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"boundaries"</span><span class="p">:</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1061"> <h5>Example<a class="headerlink" href="#qapidoc-1061" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">new</span> <span class="n">histogram</span> <span class="n">only</span> <span class="k">for</span> <span class="n">write</span><span class="p">,</span> <span class="n">other</span> <span class="n">histograms</span> <span class="n">will</span> <span class="n">remain</span> <span class="ow">not</span> <span class="n">changed</span> <span class="p">(</span><span class="ow">or</span> <span class="ow">not</span> <span class="n">created</span><span class="p">):</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-latency-histogram-set"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"boundaries-write"</span><span class="p">:</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1062"> <h5>Example<a class="headerlink" href="#qapidoc-1062" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">set</span> <span class="n">new</span> <span class="n">histograms</span> <span class="k">with</span> <span class="n">the</span> <span class="n">following</span> <span class="n">intervals</span><span class="p">:</span> <span class="n">read</span><span class="p">,</span> <span class="n">flush</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">),</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">50</span><span class="p">),</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">),</span> <span class="p">[</span><span class="mi">100</span><span class="p">,</span> <span class="o">+</span><span class="n">inf</span><span class="p">)</span> <span class="n">write</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1000</span><span class="p">),</span> <span class="p">[</span><span class="mi">1000</span><span class="p">,</span> <span class="mi">5000</span><span class="p">),</span> <span class="p">[</span><span class="mi">5000</span><span class="p">,</span> <span class="o">+</span><span class="n">inf</span><span class="p">)</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-latency-histogram-set"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"drive0"</span><span class="p">,</span> <span class="s2">"boundaries"</span><span class="p">:</span> <span class="p">[</span><span class="mi">10</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">],</span> <span class="s2">"boundaries-write"</span><span class="p">:</span> <span class="p">[</span><span class="mi">1000</span><span class="p">,</span> <span class="mi">5000</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1063"> <h5>Example<a class="headerlink" href="#qapidoc-1063" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">remove</span> <span class="nb">all</span> <span class="n">latency</span> <span class="n">histograms</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"block-latency-histogram-set"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"drive0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1065"> <h3><a class="toc-backref" href="#id98">Block device exports</a><a class="headerlink" href="#qapidoc-1065" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1068"> <h4><code class="docutils literal notranslate"><span class="pre">NbdServerOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-1068" title="Permalink to this headline">¶</a></h4> <p>Keep this type consistent with the nbd-server-start arguments. The only intended difference is using SocketAddress instead of SocketAddressLegacy.</p> <div class="section" id="qapidoc-1066"> <h5>Members<a class="headerlink" href="#qapidoc-1066" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code></dt> <dd>Address on which to listen.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the TLS credentials object (since 2.6).</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the QAuthZ authorization object used to validate the client’s x509 distinguished name. This object is is only resolved at time of use, so can be deleted and recreated on the fly while the NBD server is active. If missing, it will default to denying access (since 4.0).</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-connections</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The maximum number of connections to allow at the same time, 0 for unlimited. (since 5.2; default: 100)</dd> </dl> </div> <div class="section" id="qapidoc-1067"> <h5>Since<a class="headerlink" href="#qapidoc-1067" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-1072"> <h4><code class="docutils literal notranslate"><span class="pre">nbd-server-start</span></code> (Command)<a class="headerlink" href="#qapidoc-1072" title="Permalink to this headline">¶</a></h4> <p>Start an NBD server listening on the given host and port. Block devices can then be exported using <code class="docutils literal notranslate"><span class="pre">nbd-server-add</span></code>. The NBD server will present them as named exports; for example, another QEMU instance could refer to them as “nbd:HOST:PORT:exportname=NAME”.</p> <p>Keep this type consistent with the NbdServerOptions type. The only intended difference is using SocketAddressLegacy instead of SocketAddress.</p> <div class="section" id="qapidoc-1069"> <h5>Arguments<a class="headerlink" href="#qapidoc-1069" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code></dt> <dd>Address on which to listen.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the TLS credentials object (since 2.6).</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the QAuthZ authorization object used to validate the client’s x509 distinguished name. This object is is only resolved at time of use, so can be deleted and recreated on the fly while the NBD server is active. If missing, it will default to denying access (since 4.0).</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-connections</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The maximum number of connections to allow at the same time, 0 for unlimited. (since 5.2; default: 100)</dd> </dl> </div> <div class="section" id="qapidoc-1070"> <h5>Returns<a class="headerlink" href="#qapidoc-1070" title="Permalink to this headline">¶</a></h5> <p>error if the server is already running.</p> </div> <div class="section" id="qapidoc-1071"> <h5>Since<a class="headerlink" href="#qapidoc-1071" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1075"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportOptionsNbdBase</span></code> (Object)<a class="headerlink" href="#qapidoc-1075" title="Permalink to this headline">¶</a></h4> <p>An NBD block export (common options shared between nbd-server-add and the NBD branch of block-export-add).</p> <div class="section" id="qapidoc-1073"> <h5>Members<a class="headerlink" href="#qapidoc-1073" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Export name. If unspecified, the <code class="docutils literal notranslate"><span class="pre">device</span></code> parameter is used as the export name. (Since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">description</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Free-form description of the export, up to 4096 bytes. (Since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-1074"> <h5>Since<a class="headerlink" href="#qapidoc-1074" title="Permalink to this headline">¶</a></h5> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-1078"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportOptionsNbd</span></code> (Object)<a class="headerlink" href="#qapidoc-1078" title="Permalink to this headline">¶</a></h4> <p>An NBD block export (distinct options used in the NBD branch of block-export-add).</p> <div class="section" id="qapidoc-1076"> <h5>Members<a class="headerlink" href="#qapidoc-1076" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>Also export each of the named dirty bitmaps reachable from <code class="docutils literal notranslate"><span class="pre">device</span></code>, so the NBD client can use NBD_OPT_SET_META_CONTEXT with the metadata context name “qemu:dirty-bitmap:BITMAP” to inspect each bitmap.</dd> <dt><code class="docutils literal notranslate"><span class="pre">allocation-depth</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Also export the allocation depth map for <code class="docutils literal notranslate"><span class="pre">device</span></code>, so the NBD client can use NBD_OPT_SET_META_CONTEXT with the metadata context name “qemu:allocation-depth” to inspect allocation details. (since 5.2)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptionsNbdBase</span></code></dl> </div> <div class="section" id="qapidoc-1077"> <h5>Since<a class="headerlink" href="#qapidoc-1077" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1081"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportOptionsVhostUserBlk</span></code> (Object)<a class="headerlink" href="#qapidoc-1081" title="Permalink to this headline">¶</a></h4> <p>A vhost-user-blk block export.</p> <div class="section" id="qapidoc-1079"> <h5>Members<a class="headerlink" href="#qapidoc-1079" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddress</span></code></dt> <dd>The vhost-user socket on which to listen. Both ‘unix’ and ‘fd’ SocketAddress types are supported. Passed fds must be UNIX domain sockets.</dd> <dt><code class="docutils literal notranslate"><span class="pre">logical-block-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Logical block size in bytes. Defaults to 512 bytes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">num-queues</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Number of request virtqueues. Must be greater than 0. Defaults to 1.</dd> </dl> </div> <div class="section" id="qapidoc-1080"> <h5>Since<a class="headerlink" href="#qapidoc-1080" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1084"> <h4><code class="docutils literal notranslate"><span class="pre">FuseExportAllowOther</span></code> (Enum)<a class="headerlink" href="#qapidoc-1084" title="Permalink to this headline">¶</a></h4> <p>Possible allow_other modes for FUSE exports.</p> <div class="section" id="qapidoc-1082"> <h5>Values<a class="headerlink" href="#qapidoc-1082" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>Do not pass allow_other as a mount option.</dd> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>Pass allow_other as a mount option.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto</span></code></dt> <dd>Try mounting with allow_other first, and if that fails, retry without allow_other.</dd> </dl> </div> <div class="section" id="qapidoc-1083"> <h5>Since<a class="headerlink" href="#qapidoc-1083" title="Permalink to this headline">¶</a></h5> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-1088"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportOptionsFuse</span></code> (Object)<a class="headerlink" href="#qapidoc-1088" title="Permalink to this headline">¶</a></h4> <p>Options for exporting a block graph node on some (file) mountpoint as a raw image.</p> <div class="section" id="qapidoc-1085"> <h5>Members<a class="headerlink" href="#qapidoc-1085" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mountpoint</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Path on which to export the block device via FUSE. This must point to an existing regular file.</dd> <dt><code class="docutils literal notranslate"><span class="pre">growable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Whether writes beyond the EOF should grow the block node accordingly. (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">allow-other</span></code>: <code class="docutils literal notranslate"><span class="pre">FuseExportAllowOther</span></code> (optional)</dt> <dd>If this is off, only qemu’s user is allowed access to this export. That cannot be changed even with chmod or chown. Enabling this option will allow other users access to the export with the FUSE mount option “allow_other”. Note that using allow_other as a non-root user requires user_allow_other to be enabled in the global fuse.conf configuration file. In auto mode (the default), the FUSE export driver will first attempt to mount the export with allow_other, and if that fails, try again without. (since 6.1; default: auto)</dd> </dl> </div> <div class="section" id="qapidoc-1086"> <h5>Since<a class="headerlink" href="#qapidoc-1086" title="Permalink to this headline">¶</a></h5> <p>6.0</p> </div> <div class="section" id="qapidoc-1087"> <h5>If<a class="headerlink" href="#qapidoc-1087" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_FUSE</span></code></p> </div> </div> <div class="section" id="qapidoc-1091"> <h4><code class="docutils literal notranslate"><span class="pre">NbdServerAddOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-1091" title="Permalink to this headline">¶</a></h4> <p>An NBD block export, per legacy nbd-server-add command.</p> <div class="section" id="qapidoc-1089"> <h5>Members<a class="headerlink" href="#qapidoc-1089" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The device name or node name of the node to be exported</dd> <dt><code class="docutils literal notranslate"><span class="pre">writable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Whether clients should be able to write to the device via the NBD connection (default false).</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmap</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Also export a single dirty bitmap reachable from <code class="docutils literal notranslate"><span class="pre">device</span></code>, so the NBD client can use NBD_OPT_SET_META_CONTEXT with the metadata context name “qemu:dirty-bitmap:BITMAP” to inspect the bitmap (since 4.0).</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptionsNbdBase</span></code></dl> </div> <div class="section" id="qapidoc-1090"> <h5>Since<a class="headerlink" href="#qapidoc-1090" title="Permalink to this headline">¶</a></h5> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-1096"> <h4><code class="docutils literal notranslate"><span class="pre">nbd-server-add</span></code> (Command)<a class="headerlink" href="#qapidoc-1096" title="Permalink to this headline">¶</a></h4> <p>Export a block node to QEMU’s embedded NBD server.</p> <p>The export name will be used as the id for the resulting block export.</p> <div class="section" id="qapidoc-1092"> <h5>Arguments<a class="headerlink" href="#qapidoc-1092" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NbdServerAddOptions</span></code></dl> </div> <div class="section" id="qapidoc-1093"> <h5>Features<a class="headerlink" href="#qapidoc-1093" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>This command is deprecated. Use <code class="docutils literal notranslate"><span class="pre">block-export-add</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1094"> <h5>Returns<a class="headerlink" href="#qapidoc-1094" title="Permalink to this headline">¶</a></h5> <p>error if the server is not running, or export with the same name already exists.</p> </div> <div class="section" id="qapidoc-1095"> <h5>Since<a class="headerlink" href="#qapidoc-1095" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1100"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportRemoveMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-1100" title="Permalink to this headline">¶</a></h4> <p>Mode for removing a block export.</p> <div class="section" id="qapidoc-1097"> <h5>Values<a class="headerlink" href="#qapidoc-1097" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">safe</span></code></dt> <dd>Remove export if there are no existing connections, fail otherwise.</dd> <dt><code class="docutils literal notranslate"><span class="pre">hard</span></code></dt> <dd>Drop all connections immediately and remove export.</dd> </dl> </div> <div class="section" id="qapidoc-1098"> <p>Potential additional modes to be added in the future:</p> <p>hide: Just hide export from new clients, leave existing connections as is. Remove export after all clients are disconnected.</p> <p>soft: Hide export from new clients, answer with ESHUTDOWN for all further requests from existing clients.</p> </div> <div class="section" id="qapidoc-1099"> <h5>Since<a class="headerlink" href="#qapidoc-1099" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-1105"> <h4><code class="docutils literal notranslate"><span class="pre">nbd-server-remove</span></code> (Command)<a class="headerlink" href="#qapidoc-1105" title="Permalink to this headline">¶</a></h4> <p>Remove NBD export by name.</p> <div class="section" id="qapidoc-1101"> <h5>Arguments<a class="headerlink" href="#qapidoc-1101" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Block export id.</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockExportRemoveMode</span></code> (optional)</dt> <dd>Mode of command operation. See <code class="docutils literal notranslate"><span class="pre">BlockExportRemoveMode</span></code> description. Default is ‘safe’.</dd> </dl> </div> <div class="section" id="qapidoc-1102"> <h5>Features<a class="headerlink" href="#qapidoc-1102" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>This command is deprecated. Use <code class="docutils literal notranslate"><span class="pre">block-export-del</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1103"> <h5>Returns<a class="headerlink" href="#qapidoc-1103" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>error if</dt> <dd><ul class="first last simple"> <li>the server is not running</li> <li>export is not found</li> <li>mode is ‘safe’ and there are existing connections</li> </ul> </dd> </dl> </div> <div class="section" id="qapidoc-1104"> <h5>Since<a class="headerlink" href="#qapidoc-1104" title="Permalink to this headline">¶</a></h5> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-1107"> <h4><code class="docutils literal notranslate"><span class="pre">nbd-server-stop</span></code> (Command)<a class="headerlink" href="#qapidoc-1107" title="Permalink to this headline">¶</a></h4> <p>Stop QEMU’s embedded NBD server, and unregister all devices previously added via <code class="docutils literal notranslate"><span class="pre">nbd-server-add</span></code>.</p> <div class="section" id="qapidoc-1106"> <h5>Since<a class="headerlink" href="#qapidoc-1106" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1110"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportType</span></code> (Enum)<a class="headerlink" href="#qapidoc-1110" title="Permalink to this headline">¶</a></h4> <p>An enumeration of block export types</p> <div class="section" id="qapidoc-1108"> <h5>Values<a class="headerlink" href="#qapidoc-1108" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">nbd</span></code></dt> <dd>NBD export</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhost-user-blk</span></code></dt> <dd>vhost-user-blk export (since 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">fuse</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_FUSE</span></code>)</dt> <dd>FUSE export (since: 6.0)</dd> </dl> </div> <div class="section" id="qapidoc-1109"> <h5>Since<a class="headerlink" href="#qapidoc-1109" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-1113"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportOptions</span></code> (Object)<a class="headerlink" href="#qapidoc-1113" title="Permalink to this headline">¶</a></h4> <p>Describes a block export, i.e. how single node should be exported on an external interface.</p> <div class="section" id="qapidoc-1111"> <h5>Members<a class="headerlink" href="#qapidoc-1111" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>A unique identifier for the block export (across all export types)</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The node name of the block node to be exported (since: 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">writable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True if clients should be able to write to the export (default false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">writethrough</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>If true, caches are flushed after every write request to the export before completion is signalled. (since: 5.2; default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">iothread</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name of the iothread object where the export will run. The default is to use the thread currently associated with the block node. (since: 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">fixed-iothread</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>True prevents the block node from being moved to another thread while the export is active. If true and <code class="docutils literal notranslate"><span class="pre">iothread</span></code> is given, export creation fails if the block node cannot be moved to the iothread. The default is false. (since: 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockExportType</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptionsNbd</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"nbd"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptionsVhostUserBlk</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vhost-user-blk"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptionsFuse</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"fuse"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_FUSE</span></code>)</dl> </div> <div class="section" id="qapidoc-1112"> <h5>Since<a class="headerlink" href="#qapidoc-1112" title="Permalink to this headline">¶</a></h5> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-1116"> <h4><code class="docutils literal notranslate"><span class="pre">block-export-add</span></code> (Command)<a class="headerlink" href="#qapidoc-1116" title="Permalink to this headline">¶</a></h4> <p>Creates a new block export.</p> <div class="section" id="qapidoc-1114"> <h5>Arguments<a class="headerlink" href="#qapidoc-1114" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockExportOptions</span></code></dl> </div> <div class="section" id="qapidoc-1115"> <h5>Since<a class="headerlink" href="#qapidoc-1115" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1120"> <h4><code class="docutils literal notranslate"><span class="pre">block-export-del</span></code> (Command)<a class="headerlink" href="#qapidoc-1120" title="Permalink to this headline">¶</a></h4> <p>Request to remove a block export. This drops the user’s reference to the export, but the export may still stay around after this command returns until the shutdown of the export has completed.</p> <div class="section" id="qapidoc-1117"> <h5>Arguments<a class="headerlink" href="#qapidoc-1117" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Block export id.</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockExportRemoveMode</span></code> (optional)</dt> <dd>Mode of command operation. See <code class="docutils literal notranslate"><span class="pre">BlockExportRemoveMode</span></code> description. Default is ‘safe’.</dd> </dl> </div> <div class="section" id="qapidoc-1118"> <h5>Returns<a class="headerlink" href="#qapidoc-1118" title="Permalink to this headline">¶</a></h5> <p>Error if the export is not found or <code class="docutils literal notranslate"><span class="pre">mode</span></code> is ‘safe’ and the export is still in use (e.g. by existing client connections)</p> </div> <div class="section" id="qapidoc-1119"> <h5>Since<a class="headerlink" href="#qapidoc-1119" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1123"> <h4><code class="docutils literal notranslate"><span class="pre">BLOCK_EXPORT_DELETED</span></code> (Event)<a class="headerlink" href="#qapidoc-1123" title="Permalink to this headline">¶</a></h4> <p>Emitted when a block export is removed and its id can be reused.</p> <div class="section" id="qapidoc-1121"> <h5>Arguments<a class="headerlink" href="#qapidoc-1121" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Block export id.</dd> </dl> </div> <div class="section" id="qapidoc-1122"> <h5>Since<a class="headerlink" href="#qapidoc-1122" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1126"> <h4><code class="docutils literal notranslate"><span class="pre">BlockExportInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1126" title="Permalink to this headline">¶</a></h4> <p>Information about a single block export.</p> <div class="section" id="qapidoc-1124"> <h5>Members<a class="headerlink" href="#qapidoc-1124" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The unique identifier for the block export</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockExportType</span></code></dt> <dd>The block export type</dd> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The node name of the block node that is exported</dd> <dt><code class="docutils literal notranslate"><span class="pre">shutting-down</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>True if the export is shutting down (e.g. after a block-export-del command, but before the shutdown has completed)</dd> </dl> </div> <div class="section" id="qapidoc-1125"> <h5>Since<a class="headerlink" href="#qapidoc-1125" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1129"> <h4><code class="docutils literal notranslate"><span class="pre">query-block-exports</span></code> (Command)<a class="headerlink" href="#qapidoc-1129" title="Permalink to this headline">¶</a></h4> <div class="section" id="qapidoc-1127"> <h5>Returns<a class="headerlink" href="#qapidoc-1127" title="Permalink to this headline">¶</a></h5> <p>A list of BlockExportInfo describing all block exports</p> </div> <div class="section" id="qapidoc-1128"> <h5>Since<a class="headerlink" href="#qapidoc-1128" title="Permalink to this headline">¶</a></h5> <p>5.2</p> </div> </div> </div> </div> <div class="section" id="qapidoc-1130"> <h2><a class="toc-backref" href="#id99">Character devices</a><a class="headerlink" href="#qapidoc-1130" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1134"> <h3><a class="toc-backref" href="#id100"><code class="docutils literal notranslate"><span class="pre">ChardevInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1134" title="Permalink to this headline">¶</a></h3> <p>Information about a character device.</p> <div class="section" id="qapidoc-1131"> <h4>Members<a class="headerlink" href="#qapidoc-1131" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">label</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the label of the character device</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the filename of the character device</dd> <dt><code class="docutils literal notranslate"><span class="pre">frontend-open</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>shows whether the frontend device attached to this backend (eg. with the chardev=… option) is in open or closed state (since 2.1)</dd> </dl> </div> <div class="section" id="qapidoc-1132"> <h4>Notes<a class="headerlink" href="#qapidoc-1132" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">filename</span></code> is encoded using the QEMU command line character device encoding. See the QEMU man page for details.</p> </div> <div class="section" id="qapidoc-1133"> <h4>Since<a class="headerlink" href="#qapidoc-1133" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-1138"> <h3><a class="toc-backref" href="#id101"><code class="docutils literal notranslate"><span class="pre">query-chardev</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1138" title="Permalink to this headline">¶</a></h3> <p>Returns information about current character devices.</p> <div class="section" id="qapidoc-1135"> <h4>Returns<a class="headerlink" href="#qapidoc-1135" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">ChardevInfo</span></code></p> </div> <div class="section" id="qapidoc-1136"> <h4>Since<a class="headerlink" href="#qapidoc-1136" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1137"> <h4>Example<a class="headerlink" href="#qapidoc-1137" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-chardev"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"charchannel0"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server=on"</span><span class="p">,</span> <span class="s2">"frontend-open"</span><span class="p">:</span> <span class="n">false</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"charmonitor"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server=on"</span><span class="p">,</span> <span class="s2">"frontend-open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"charserial0"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"pty:/dev/pts/2"</span><span class="p">,</span> <span class="s2">"frontend-open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1141"> <h3><a class="toc-backref" href="#id102"><code class="docutils literal notranslate"><span class="pre">ChardevBackendInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1141" title="Permalink to this headline">¶</a></h3> <p>Information about a character device backend</p> <div class="section" id="qapidoc-1139"> <h4>Members<a class="headerlink" href="#qapidoc-1139" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The backend name</dd> </dl> </div> <div class="section" id="qapidoc-1140"> <h4>Since<a class="headerlink" href="#qapidoc-1140" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1145"> <h3><a class="toc-backref" href="#id103"><code class="docutils literal notranslate"><span class="pre">query-chardev-backends</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1145" title="Permalink to this headline">¶</a></h3> <p>Returns information about character device backends.</p> <div class="section" id="qapidoc-1142"> <h4>Returns<a class="headerlink" href="#qapidoc-1142" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">ChardevBackendInfo</span></code></p> </div> <div class="section" id="qapidoc-1143"> <h4>Since<a class="headerlink" href="#qapidoc-1143" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> <div class="section" id="qapidoc-1144"> <h4>Example<a class="headerlink" href="#qapidoc-1144" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-chardev-backends"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"udp"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"tcp"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"unix"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"spiceport"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1148"> <h3><a class="toc-backref" href="#id104"><code class="docutils literal notranslate"><span class="pre">DataFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1148" title="Permalink to this headline">¶</a></h3> <p>An enumeration of data format.</p> <div class="section" id="qapidoc-1146"> <h4>Values<a class="headerlink" href="#qapidoc-1146" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">utf8</span></code></dt> <dd>Data is a UTF-8 string (RFC 3629)</dd> <dt><code class="docutils literal notranslate"><span class="pre">base64</span></code></dt> <dd>Data is Base64 encoded binary (RFC 3548)</dd> </dl> </div> <div class="section" id="qapidoc-1147"> <h4>Since<a class="headerlink" href="#qapidoc-1147" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1153"> <h3><a class="toc-backref" href="#id105"><code class="docutils literal notranslate"><span class="pre">ringbuf-write</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1153" title="Permalink to this headline">¶</a></h3> <p>Write to a ring buffer character device.</p> <div class="section" id="qapidoc-1149"> <h4>Arguments<a class="headerlink" href="#qapidoc-1149" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the ring buffer character device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>data to write</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">DataFormat</span></code> (optional)</dt> <dd><p class="first">data encoding (default ‘utf8’).</p> <ul class="last simple"> <li>base64: data must be base64 encoded text. Its binary decoding gets written.</li> <li>utf8: data’s UTF-8 encoding is written</li> <li>data itself is always Unicode regardless of format, like any other string.</li> </ul> </dd> </dl> </div> <div class="section" id="qapidoc-1150"> <h4>Returns<a class="headerlink" href="#qapidoc-1150" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-1151"> <h4>Since<a class="headerlink" href="#qapidoc-1151" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> <div class="section" id="qapidoc-1152"> <h4>Example<a class="headerlink" href="#qapidoc-1152" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"ringbuf-write"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"abcdefgh"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"utf8"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1158"> <h3><a class="toc-backref" href="#id106"><code class="docutils literal notranslate"><span class="pre">ringbuf-read</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1158" title="Permalink to this headline">¶</a></h3> <p>Read from a ring buffer character device.</p> <div class="section" id="qapidoc-1154"> <h4>Arguments<a class="headerlink" href="#qapidoc-1154" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the ring buffer character device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>how many bytes to read at most</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">DataFormat</span></code> (optional)</dt> <dd><p class="first">data encoding (default ‘utf8’).</p> <ul class="last simple"> <li>base64: the data read is returned in base64 encoding.</li> <li>utf8: the data read is interpreted as UTF-8. Bug: can screw up when the buffer contains invalid UTF-8 sequences, NUL characters, after the ring buffer lost data, and when reading stops because the size limit is reached.</li> <li>The return value is always Unicode regardless of format, like any other string.</li> </ul> </dd> </dl> </div> <div class="section" id="qapidoc-1155"> <h4>Returns<a class="headerlink" href="#qapidoc-1155" title="Permalink to this headline">¶</a></h4> <p>data read from the device</p> </div> <div class="section" id="qapidoc-1156"> <h4>Since<a class="headerlink" href="#qapidoc-1156" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> <div class="section" id="qapidoc-1157"> <h4>Example<a class="headerlink" href="#qapidoc-1157" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"ringbuf-read"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">1000</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"utf8"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="s2">"abcdefgh"</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1161"> <h3><a class="toc-backref" href="#id107"><code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1161" title="Permalink to this headline">¶</a></h3> <p>Configuration shared across all chardev backends</p> <div class="section" id="qapidoc-1159"> <h4>Members<a class="headerlink" href="#qapidoc-1159" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">logfile</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name of a logfile to save output</dd> <dt><code class="docutils literal notranslate"><span class="pre">logappend</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true to append instead of truncate (default to false to truncate)</dd> </dl> </div> <div class="section" id="qapidoc-1160"> <h4>Since<a class="headerlink" href="#qapidoc-1160" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-1164"> <h3><a class="toc-backref" href="#id108"><code class="docutils literal notranslate"><span class="pre">ChardevFile</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1164" title="Permalink to this headline">¶</a></h3> <p>Configuration info for file chardevs.</p> <div class="section" id="qapidoc-1162"> <h4>Members<a class="headerlink" href="#qapidoc-1162" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name of the input file</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name of the output file</dd> <dt><code class="docutils literal notranslate"><span class="pre">append</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Open the file in append mode (default false to truncate) (Since 2.6)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1163"> <h4>Since<a class="headerlink" href="#qapidoc-1163" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1167"> <h3><a class="toc-backref" href="#id109"><code class="docutils literal notranslate"><span class="pre">ChardevHostdev</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1167" title="Permalink to this headline">¶</a></h3> <p>Configuration info for device and pipe chardevs.</p> <div class="section" id="qapidoc-1165"> <h4>Members<a class="headerlink" href="#qapidoc-1165" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name of the special file for the device, i.e. /dev/ttyS0 on Unix or COM1: on Windows</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1166"> <h4>Since<a class="headerlink" href="#qapidoc-1166" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1170"> <h3><a class="toc-backref" href="#id110"><code class="docutils literal notranslate"><span class="pre">ChardevSocket</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1170" title="Permalink to this headline">¶</a></h3> <p>Configuration info for (stream) socket chardevs.</p> <div class="section" id="qapidoc-1168"> <h4>Members<a class="headerlink" href="#qapidoc-1168" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code></dt> <dd>socket address to listen on (server=true) or connect to (server=false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the ID of the TLS credentials object (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the ID of the QAuthZ authorization object against which the client’s x509 distinguished name will be validated. This object is only resolved at time of use, so can be deleted and recreated on the fly while the chardev server is active. If missing, it will default to denying access (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>create server socket (default: true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">wait</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>wait for incoming connection on server sockets (default: false). Silently ignored with server: false. This use is deprecated.</dd> <dt><code class="docutils literal notranslate"><span class="pre">nodelay</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>set TCP_NODELAY socket option (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">telnet</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable telnet protocol on server sockets (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tn3270</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable tn3270 protocol on server sockets (default: false) (Since: 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">websocket</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable websocket protocol on server sockets (default: false) (Since: 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reconnect</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>For a client socket, if a socket is disconnected, then attempt a reconnect after the given number of seconds. Setting this to zero disables this function. (default: 0) (Since: 2.2)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1169"> <h4>Since<a class="headerlink" href="#qapidoc-1169" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1173"> <h3><a class="toc-backref" href="#id111"><code class="docutils literal notranslate"><span class="pre">ChardevUdp</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1173" title="Permalink to this headline">¶</a></h3> <p>Configuration info for datagram socket chardevs.</p> <div class="section" id="qapidoc-1171"> <h4>Members<a class="headerlink" href="#qapidoc-1171" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">remote</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code></dt> <dd>remote address</dd> <dt><code class="docutils literal notranslate"><span class="pre">local</span></code>: <code class="docutils literal notranslate"><span class="pre">SocketAddressLegacy</span></code> (optional)</dt> <dd>local address</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1172"> <h4>Since<a class="headerlink" href="#qapidoc-1172" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1176"> <h3><a class="toc-backref" href="#id112"><code class="docutils literal notranslate"><span class="pre">ChardevMux</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1176" title="Permalink to this headline">¶</a></h3> <p>Configuration info for mux chardevs.</p> <div class="section" id="qapidoc-1174"> <h4>Members<a class="headerlink" href="#qapidoc-1174" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the base chardev.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1175"> <h4>Since<a class="headerlink" href="#qapidoc-1175" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1179"> <h3><a class="toc-backref" href="#id113"><code class="docutils literal notranslate"><span class="pre">ChardevStdio</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1179" title="Permalink to this headline">¶</a></h3> <p>Configuration info for stdio chardevs.</p> <div class="section" id="qapidoc-1177"> <h4>Members<a class="headerlink" href="#qapidoc-1177" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">signal</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Allow signals (such as SIGINT triggered by ^C) be delivered to qemu. Default: true.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1178"> <h4>Since<a class="headerlink" href="#qapidoc-1178" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1183"> <h3><a class="toc-backref" href="#id114"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannel</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1183" title="Permalink to this headline">¶</a></h3> <p>Configuration info for spice vm channel chardevs.</p> <div class="section" id="qapidoc-1180"> <h4>Members<a class="headerlink" href="#qapidoc-1180" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>kind of channel (for example vdagent).</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1181"> <h4>Since<a class="headerlink" href="#qapidoc-1181" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1182"> <h4>If<a class="headerlink" href="#qapidoc-1182" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1187"> <h3><a class="toc-backref" href="#id115"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePort</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1187" title="Permalink to this headline">¶</a></h3> <p>Configuration info for spice port chardevs.</p> <div class="section" id="qapidoc-1184"> <h4>Members<a class="headerlink" href="#qapidoc-1184" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fqdn</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the channel (see docs/spice-port-fqdn.txt)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1185"> <h4>Since<a class="headerlink" href="#qapidoc-1185" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1186"> <h4>If<a class="headerlink" href="#qapidoc-1186" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1190"> <h3><a class="toc-backref" href="#id116"><code class="docutils literal notranslate"><span class="pre">ChardevVC</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1190" title="Permalink to this headline">¶</a></h3> <p>Configuration info for virtual console chardevs.</p> <div class="section" id="qapidoc-1188"> <h4>Members<a class="headerlink" href="#qapidoc-1188" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">width</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>console width, in pixels</dd> <dt><code class="docutils literal notranslate"><span class="pre">height</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>console height, in pixels</dd> <dt><code class="docutils literal notranslate"><span class="pre">cols</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>console width, in chars</dd> <dt><code class="docutils literal notranslate"><span class="pre">rows</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>console height, in chars</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1189"> <h4>Since<a class="headerlink" href="#qapidoc-1189" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1193"> <h3><a class="toc-backref" href="#id117"><code class="docutils literal notranslate"><span class="pre">ChardevRingbuf</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1193" title="Permalink to this headline">¶</a></h3> <p>Configuration info for ring buffer chardevs.</p> <div class="section" id="qapidoc-1191"> <h4>Members<a class="headerlink" href="#qapidoc-1191" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>ring buffer size, must be power of two, default is 65536</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1192"> <h4>Since<a class="headerlink" href="#qapidoc-1192" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1197"> <h3><a class="toc-backref" href="#id118"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1197" title="Permalink to this headline">¶</a></h3> <p>Configuration info for qemu vdagent implementation.</p> <div class="section" id="qapidoc-1194"> <h4>Members<a class="headerlink" href="#qapidoc-1194" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mouse</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable/disable mouse, default is enabled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">clipboard</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable/disable clipboard, default is disabled.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dl> </div> <div class="section" id="qapidoc-1195"> <h4>Since<a class="headerlink" href="#qapidoc-1195" title="Permalink to this headline">¶</a></h4> <p>6.1</p> </div> <div class="section" id="qapidoc-1196"> <h4>If<a class="headerlink" href="#qapidoc-1196" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE_PROTOCOL</span></code></p> </div> </div> <div class="section" id="qapidoc-1200"> <h3><a class="toc-backref" href="#id119"><code class="docutils literal notranslate"><span class="pre">ChardevBackendKind</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1200" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1198"> <h4>Values<a class="headerlink" href="#qapidoc-1198" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pipe</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">udp</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">mux</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">msmouse</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">wctablet</span></code></dt> <dd>Since 2.9</dd> <dt><code class="docutils literal notranslate"><span class="pre">braille</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">testdev</span></code></dt> <dd>Since 2.2</dd> <dt><code class="docutils literal notranslate"><span class="pre">stdio</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">console</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">spicevmc</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code>)</dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">spiceport</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code>)</dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">qemu-vdagent</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE_PROTOCOL</span></code>)</dt> <dd>Since 6.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">vc</span></code></dt> <dd>v1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">ringbuf</span></code></dt> <dd>Since 1.6</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory</span></code></dt> <dd>Since 1.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">serial</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">parallel</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">socket</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pty</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">null</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1199"> <h4>Since<a class="headerlink" href="#qapidoc-1199" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1203"> <h3><a class="toc-backref" href="#id120"><code class="docutils literal notranslate"><span class="pre">ChardevFileWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1203" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1201"> <h4>Members<a class="headerlink" href="#qapidoc-1201" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevFile</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1202"> <h4>Since<a class="headerlink" href="#qapidoc-1202" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1206"> <h3><a class="toc-backref" href="#id121"><code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1206" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1204"> <h4>Members<a class="headerlink" href="#qapidoc-1204" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevHostdev</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1205"> <h4>Since<a class="headerlink" href="#qapidoc-1205" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1209"> <h3><a class="toc-backref" href="#id122"><code class="docutils literal notranslate"><span class="pre">ChardevSocketWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1209" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1207"> <h4>Members<a class="headerlink" href="#qapidoc-1207" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevSocket</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1208"> <h4>Since<a class="headerlink" href="#qapidoc-1208" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1212"> <h3><a class="toc-backref" href="#id123"><code class="docutils literal notranslate"><span class="pre">ChardevUdpWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1212" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1210"> <h4>Members<a class="headerlink" href="#qapidoc-1210" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevUdp</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1211"> <h4>Since<a class="headerlink" href="#qapidoc-1211" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1215"> <h3><a class="toc-backref" href="#id124"><code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1215" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1213"> <h4>Members<a class="headerlink" href="#qapidoc-1213" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevCommon</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1214"> <h4>Since<a class="headerlink" href="#qapidoc-1214" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-1218"> <h3><a class="toc-backref" href="#id125"><code class="docutils literal notranslate"><span class="pre">ChardevMuxWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1218" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1216"> <h4>Members<a class="headerlink" href="#qapidoc-1216" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevMux</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1217"> <h4>Since<a class="headerlink" href="#qapidoc-1217" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1221"> <h3><a class="toc-backref" href="#id126"><code class="docutils literal notranslate"><span class="pre">ChardevStdioWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1221" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1219"> <h4>Members<a class="headerlink" href="#qapidoc-1219" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevStdio</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1220"> <h4>Since<a class="headerlink" href="#qapidoc-1220" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1225"> <h3><a class="toc-backref" href="#id127"><code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannelWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1225" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1222"> <h4>Members<a class="headerlink" href="#qapidoc-1222" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannel</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1223"> <h4>Since<a class="headerlink" href="#qapidoc-1223" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1224"> <h4>If<a class="headerlink" href="#qapidoc-1224" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1229"> <h3><a class="toc-backref" href="#id128"><code class="docutils literal notranslate"><span class="pre">ChardevSpicePortWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1229" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1226"> <h4>Members<a class="headerlink" href="#qapidoc-1226" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevSpicePort</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1227"> <h4>Since<a class="headerlink" href="#qapidoc-1227" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1228"> <h4>If<a class="headerlink" href="#qapidoc-1228" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1233"> <h3><a class="toc-backref" href="#id129"><code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgentWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1233" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1230"> <h4>Members<a class="headerlink" href="#qapidoc-1230" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgent</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1231"> <h4>Since<a class="headerlink" href="#qapidoc-1231" title="Permalink to this headline">¶</a></h4> <p>6.1</p> </div> <div class="section" id="qapidoc-1232"> <h4>If<a class="headerlink" href="#qapidoc-1232" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE_PROTOCOL</span></code></p> </div> </div> <div class="section" id="qapidoc-1236"> <h3><a class="toc-backref" href="#id130"><code class="docutils literal notranslate"><span class="pre">ChardevVCWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1236" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1234"> <h4>Members<a class="headerlink" href="#qapidoc-1234" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevVC</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1235"> <h4>Since<a class="headerlink" href="#qapidoc-1235" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1239"> <h3><a class="toc-backref" href="#id131"><code class="docutils literal notranslate"><span class="pre">ChardevRingbufWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1239" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1237"> <h4>Members<a class="headerlink" href="#qapidoc-1237" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevRingbuf</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1238"> <h4>Since<a class="headerlink" href="#qapidoc-1238" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-1242"> <h3><a class="toc-backref" href="#id132"><code class="docutils literal notranslate"><span class="pre">ChardevBackend</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1242" title="Permalink to this headline">¶</a></h3> <p>Configuration info for the new chardev backend.</p> <div class="section" id="qapidoc-1240"> <h4>Members<a class="headerlink" href="#qapidoc-1240" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevBackendKind</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevFileWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"file"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"serial"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"parallel"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevHostdevWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"pipe"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevSocketWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"socket"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevUdpWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"udp"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"pty"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"null"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevMuxWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"mux"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"msmouse"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"wctablet"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"braille"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"testdev"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevStdioWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"stdio"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevCommonWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"console"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevSpiceChannelWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"spicevmc"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevSpicePortWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"spiceport"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevQemuVDAgentWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"qemu-vdagent"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE_PROTOCOL</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevVCWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vc"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevRingbufWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"ringbuf"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ChardevRingbufWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"memory"</span></code></dl> </div> <div class="section" id="qapidoc-1241"> <h4>Since<a class="headerlink" href="#qapidoc-1241" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1245"> <h3><a class="toc-backref" href="#id133"><code class="docutils literal notranslate"><span class="pre">ChardevReturn</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1245" title="Permalink to this headline">¶</a></h3> <p>Return info about the chardev backend just created.</p> <div class="section" id="qapidoc-1243"> <h4>Members<a class="headerlink" href="#qapidoc-1243" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pty</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the slave pseudoterminal device, present if and only if a chardev of type ‘pty’ was created</dd> </dl> </div> <div class="section" id="qapidoc-1244"> <h4>Since<a class="headerlink" href="#qapidoc-1244" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> </div> <div class="section" id="qapidoc-1250"> <h3><a class="toc-backref" href="#id134"><code class="docutils literal notranslate"><span class="pre">chardev-add</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1250" title="Permalink to this headline">¶</a></h3> <p>Add a character device backend</p> <div class="section" id="qapidoc-1246"> <h4>Arguments<a class="headerlink" href="#qapidoc-1246" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev’s ID, must be unique</dd> <dt><code class="docutils literal notranslate"><span class="pre">backend</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevBackend</span></code></dt> <dd>backend type and parameters</dd> </dl> </div> <div class="section" id="qapidoc-1247"> <h4>Returns<a class="headerlink" href="#qapidoc-1247" title="Permalink to this headline">¶</a></h4> <p>ChardevReturn.</p> </div> <div class="section" id="qapidoc-1248"> <h4>Since<a class="headerlink" href="#qapidoc-1248" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> <div class="section" id="qapidoc-1249"> <h4>Example<a class="headerlink" href="#qapidoc-1249" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"chardev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="s2">"backend"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"null"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"chardev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"bar"</span><span class="p">,</span> <span class="s2">"backend"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"out"</span> <span class="p">:</span> <span class="s2">"/tmp/bar.log"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"chardev-add"</span><span class="p">,</span> <span class="s2">"arguments"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"baz"</span><span class="p">,</span> <span class="s2">"backend"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"pty"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"pty"</span> <span class="p">:</span> <span class="s2">"/dev/pty/42"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1255"> <h3><a class="toc-backref" href="#id135"><code class="docutils literal notranslate"><span class="pre">chardev-change</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1255" title="Permalink to this headline">¶</a></h3> <p>Change a character device backend</p> <div class="section" id="qapidoc-1251"> <h4>Arguments<a class="headerlink" href="#qapidoc-1251" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev’s ID, must exist</dd> <dt><code class="docutils literal notranslate"><span class="pre">backend</span></code>: <code class="docutils literal notranslate"><span class="pre">ChardevBackend</span></code></dt> <dd>new backend type and parameters</dd> </dl> </div> <div class="section" id="qapidoc-1252"> <h4>Returns<a class="headerlink" href="#qapidoc-1252" title="Permalink to this headline">¶</a></h4> <p>ChardevReturn.</p> </div> <div class="section" id="qapidoc-1253"> <h4>Since<a class="headerlink" href="#qapidoc-1253" title="Permalink to this headline">¶</a></h4> <p>2.10</p> </div> <div class="section" id="qapidoc-1254"> <h4>Example<a class="headerlink" href="#qapidoc-1254" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"chardev-change"</span><span class="p">,</span> <span class="s2">"arguments"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"baz"</span><span class="p">,</span> <span class="s2">"backend"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"pty"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"pty"</span> <span class="p">:</span> <span class="s2">"/dev/pty/42"</span> <span class="p">}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span><span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"chardev-change"</span><span class="p">,</span> <span class="s2">"arguments"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"charchannel2"</span><span class="p">,</span> <span class="s2">"backend"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"socket"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"addr"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span> <span class="p">:</span> <span class="s2">"unix"</span> <span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"path"</span> <span class="p">:</span> <span class="s2">"/tmp/charchannel2.socket"</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"server"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"wait"</span> <span class="p">:</span> <span class="n">false</span> <span class="p">}}}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">{}}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1260"> <h3><a class="toc-backref" href="#id136"><code class="docutils literal notranslate"><span class="pre">chardev-remove</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1260" title="Permalink to this headline">¶</a></h3> <p>Remove a character device backend</p> <div class="section" id="qapidoc-1256"> <h4>Arguments<a class="headerlink" href="#qapidoc-1256" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev’s ID, must exist and not be in use</dd> </dl> </div> <div class="section" id="qapidoc-1257"> <h4>Returns<a class="headerlink" href="#qapidoc-1257" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-1258"> <h4>Since<a class="headerlink" href="#qapidoc-1258" title="Permalink to this headline">¶</a></h4> <p>1.4</p> </div> <div class="section" id="qapidoc-1259"> <h4>Example<a class="headerlink" href="#qapidoc-1259" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"chardev-remove"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"foo"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1265"> <h3><a class="toc-backref" href="#id137"><code class="docutils literal notranslate"><span class="pre">chardev-send-break</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1265" title="Permalink to this headline">¶</a></h3> <p>Send a break to a character device</p> <div class="section" id="qapidoc-1261"> <h4>Arguments<a class="headerlink" href="#qapidoc-1261" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev’s ID, must exist</dd> </dl> </div> <div class="section" id="qapidoc-1262"> <h4>Returns<a class="headerlink" href="#qapidoc-1262" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-1263"> <h4>Since<a class="headerlink" href="#qapidoc-1263" title="Permalink to this headline">¶</a></h4> <p>2.10</p> </div> <div class="section" id="qapidoc-1264"> <h4>Example<a class="headerlink" href="#qapidoc-1264" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"chardev-send-break"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span> <span class="p">:</span> <span class="s2">"foo"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1270"> <h3><a class="toc-backref" href="#id138"><code class="docutils literal notranslate"><span class="pre">VSERPORT_CHANGE</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1270" title="Permalink to this headline">¶</a></h3> <p>Emitted when the guest opens or closes a virtio-serial port.</p> <div class="section" id="qapidoc-1266"> <h4>Arguments<a class="headerlink" href="#qapidoc-1266" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device identifier of the virtio-serial port</dd> <dt><code class="docutils literal notranslate"><span class="pre">open</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the guest has opened the virtio-serial port</dd> </dl> </div> <div class="section" id="qapidoc-1267"> <h4>Note<a class="headerlink" href="#qapidoc-1267" title="Permalink to this headline">¶</a></h4> <p>This event is rate-limited.</p> </div> <div class="section" id="qapidoc-1268"> <h4>Since<a class="headerlink" href="#qapidoc-1268" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-1269"> <h4>Example<a class="headerlink" href="#qapidoc-1269" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"VSERPORT_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"channel0"</span><span class="p">,</span> <span class="s2">"open"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1401385907</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">422329</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1271"> <h2><a class="toc-backref" href="#id139">Dump guest memory</a><a class="headerlink" href="#qapidoc-1271" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1274"> <h3><a class="toc-backref" href="#id140"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1274" title="Permalink to this headline">¶</a></h3> <p>An enumeration of guest-memory-dump’s format.</p> <div class="section" id="qapidoc-1272"> <h4>Values<a class="headerlink" href="#qapidoc-1272" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">elf</span></code></dt> <dd>elf format</dd> <dt><code class="docutils literal notranslate"><span class="pre">kdump-zlib</span></code></dt> <dd>kdump-compressed format with zlib-compressed</dd> <dt><code class="docutils literal notranslate"><span class="pre">kdump-lzo</span></code></dt> <dd>kdump-compressed format with lzo-compressed</dd> <dt><code class="docutils literal notranslate"><span class="pre">kdump-snappy</span></code></dt> <dd>kdump-compressed format with snappy-compressed</dd> <dt><code class="docutils literal notranslate"><span class="pre">win-dmp</span></code></dt> <dd>Windows full crashdump format, can be used instead of ELF converting (since 2.13)</dd> </dl> </div> <div class="section" id="qapidoc-1273"> <h4>Since<a class="headerlink" href="#qapidoc-1273" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1280"> <h3><a class="toc-backref" href="#id141"><code class="docutils literal notranslate"><span class="pre">dump-guest-memory</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1280" title="Permalink to this headline">¶</a></h3> <p>Dump guest’s memory to vmcore. It is a synchronous operation that can take very long depending on the amount of guest memory.</p> <div class="section" id="qapidoc-1275"> <h4>Arguments<a class="headerlink" href="#qapidoc-1275" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">paging</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd><p class="first">if true, do paging to get guest’s memory mapping. This allows using gdb to process the core file.</p> <p>IMPORTANT: this option can make QEMU allocate several gigabytes of RAM. This can happen for a large guest, or a malicious guest pretending to be large.</p> <p>Also, paging=true has the following limitations:</p> <blockquote class="last"> <div><ol class="arabic simple"> <li>The guest may be in a catastrophic state or can have corrupted memory, which cannot be trusted</li> <li>The guest can be in real-mode even if paging is enabled. For example, the guest uses ACPI to sleep, and ACPI sleep state goes in real-mode</li> <li>Currently only supported on i386 and x86_64.</li> </ol> </div></blockquote> </dd> <dt><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><p class="first">the filename or file descriptor of the vmcore. The supported protocols are:</p> <ol class="last arabic simple"> <li>file: the protocol starts with “file:”, and the following string is the file’s path.</li> <li>fd: the protocol starts with “fd:”, and the following string is the fd’s name.</li> </ol> </dd> <dt><code class="docutils literal notranslate"><span class="pre">detach</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, QMP will return immediately rather than waiting for the dump to finish. The user can track progress using “query-dump”. (since 2.6).</dd> <dt><code class="docutils literal notranslate"><span class="pre">begin</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if specified, the starting physical address.</dd> <dt><code class="docutils literal notranslate"><span class="pre">length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if specified, the memory size, in bytes. If you don’t want to dump all guest’s memory, please specify the start <code class="docutils literal notranslate"><span class="pre">begin</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryFormat</span></code> (optional)</dt> <dd>if specified, the format of guest memory dump. But non-elf format is conflict with paging and filter, ie. <code class="docutils literal notranslate"><span class="pre">paging</span></code>, <code class="docutils literal notranslate"><span class="pre">begin</span></code> and <code class="docutils literal notranslate"><span class="pre">length</span></code> is not allowed to be specified with non-elf <code class="docutils literal notranslate"><span class="pre">format</span></code> at the same time (since 2.0)</dd> </dl> </div> <div class="section" id="qapidoc-1276"> <h4>Note<a class="headerlink" href="#qapidoc-1276" title="Permalink to this headline">¶</a></h4> <p>All boolean arguments default to false</p> </div> <div class="section" id="qapidoc-1277"> <h4>Returns<a class="headerlink" href="#qapidoc-1277" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> </div> <div class="section" id="qapidoc-1278"> <h4>Since<a class="headerlink" href="#qapidoc-1278" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-1279"> <h4>Example<a class="headerlink" href="#qapidoc-1279" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"dump-guest-memory"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"fd:dump"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1283"> <h3><a class="toc-backref" href="#id142"><code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1283" title="Permalink to this headline">¶</a></h3> <p>Describe the status of a long-running background guest memory dump.</p> <div class="section" id="qapidoc-1281"> <h4>Values<a class="headerlink" href="#qapidoc-1281" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>no dump-guest-memory has started yet.</dd> <dt><code class="docutils literal notranslate"><span class="pre">active</span></code></dt> <dd>there is one dump running in background.</dd> <dt><code class="docutils literal notranslate"><span class="pre">completed</span></code></dt> <dd>the last dump has finished successfully.</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed</span></code></dt> <dd>the last dump has failed.</dd> </dl> </div> <div class="section" id="qapidoc-1282"> <h4>Since<a class="headerlink" href="#qapidoc-1282" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-1286"> <h3><a class="toc-backref" href="#id143"><code class="docutils literal notranslate"><span class="pre">DumpQueryResult</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1286" title="Permalink to this headline">¶</a></h3> <p>The result format for ‘query-dump’.</p> <div class="section" id="qapidoc-1284"> <h4>Members<a class="headerlink" href="#qapidoc-1284" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code></dt> <dd>enum of <code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code>, which shows current dump status</dd> <dt><code class="docutils literal notranslate"><span class="pre">completed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>bytes written in latest dump (uncompressed)</dd> <dt><code class="docutils literal notranslate"><span class="pre">total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total bytes to be written in latest dump (uncompressed)</dd> </dl> </div> <div class="section" id="qapidoc-1285"> <h4>Since<a class="headerlink" href="#qapidoc-1285" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-1290"> <h3><a class="toc-backref" href="#id144"><code class="docutils literal notranslate"><span class="pre">query-dump</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1290" title="Permalink to this headline">¶</a></h3> <p>Query latest dump status.</p> <div class="section" id="qapidoc-1287"> <h4>Returns<a class="headerlink" href="#qapidoc-1287" title="Permalink to this headline">¶</a></h4> <p>A <code class="docutils literal notranslate"><span class="pre">DumpStatus</span></code> object showing the dump status.</p> </div> <div class="section" id="qapidoc-1288"> <h4>Since<a class="headerlink" href="#qapidoc-1288" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-1289"> <h4>Example<a class="headerlink" href="#qapidoc-1289" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-dump"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"active"</span><span class="p">,</span> <span class="s2">"completed"</span><span class="p">:</span> <span class="mi">1024000</span><span class="p">,</span> <span class="s2">"total"</span><span class="p">:</span> <span class="mi">2048000</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1294"> <h3><a class="toc-backref" href="#id145"><code class="docutils literal notranslate"><span class="pre">DUMP_COMPLETED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1294" title="Permalink to this headline">¶</a></h3> <p>Emitted when background dump has completed</p> <div class="section" id="qapidoc-1291"> <h4>Arguments<a class="headerlink" href="#qapidoc-1291" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">result</span></code>: <code class="docutils literal notranslate"><span class="pre">DumpQueryResult</span></code></dt> <dd>final dump status</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>human-readable error string that provides hint on why dump failed. Only presents on failure. The user should not try to interpret the error string.</dd> </dl> </div> <div class="section" id="qapidoc-1292"> <h4>Since<a class="headerlink" href="#qapidoc-1292" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-1293"> <h4>Example<a class="headerlink" href="#qapidoc-1293" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DUMP_COMPLETED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"result"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"total"</span><span class="p">:</span> <span class="mi">1090650112</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"completed"</span><span class="p">,</span> <span class="s2">"completed"</span><span class="p">:</span> <span class="mi">1090650112</span><span class="p">}</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1297"> <h3><a class="toc-backref" href="#id146"><code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryCapability</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1297" title="Permalink to this headline">¶</a></h3> <p>A list of the available formats for dump-guest-memory</p> <div class="section" id="qapidoc-1295"> <h4>Members<a class="headerlink" href="#qapidoc-1295" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">formats</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">DumpGuestMemoryFormat</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1296"> <h4>Since<a class="headerlink" href="#qapidoc-1296" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1301"> <h3><a class="toc-backref" href="#id147"><code class="docutils literal notranslate"><span class="pre">query-dump-guest-memory-capability</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1301" title="Permalink to this headline">¶</a></h3> <p>Returns the available formats for dump-guest-memory</p> <div class="section" id="qapidoc-1298"> <h4>Returns<a class="headerlink" href="#qapidoc-1298" title="Permalink to this headline">¶</a></h4> <p>A <code class="docutils literal notranslate"><span class="pre">DumpGuestMemoryCapability</span></code> object listing available formats for dump-guest-memory</p> </div> <div class="section" id="qapidoc-1299"> <h4>Since<a class="headerlink" href="#qapidoc-1299" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> <div class="section" id="qapidoc-1300"> <h4>Example<a class="headerlink" href="#qapidoc-1300" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-dump-guest-memory-capability"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"formats"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"elf"</span><span class="p">,</span> <span class="s2">"kdump-zlib"</span><span class="p">,</span> <span class="s2">"kdump-lzo"</span><span class="p">,</span> <span class="s2">"kdump-snappy"</span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1302"> <h2><a class="toc-backref" href="#id148">Net devices</a><a class="headerlink" href="#qapidoc-1302" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1308"> <h3><a class="toc-backref" href="#id149"><code class="docutils literal notranslate"><span class="pre">set_link</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1308" title="Permalink to this headline">¶</a></h3> <p>Sets the link status of a virtual network adapter.</p> <div class="section" id="qapidoc-1303"> <h4>Arguments<a class="headerlink" href="#qapidoc-1303" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name of the virtual network adapter</dd> <dt><code class="docutils literal notranslate"><span class="pre">up</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true to set the link status to be up</dd> </dl> </div> <div class="section" id="qapidoc-1304"> <h4>Returns<a class="headerlink" href="#qapidoc-1304" title="Permalink to this headline">¶</a></h4> <p>Nothing on success If <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a valid network device, DeviceNotFound</p> </div> <div class="section" id="qapidoc-1305"> <h4>Since<a class="headerlink" href="#qapidoc-1305" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1306"> <h4>Notes<a class="headerlink" href="#qapidoc-1306" title="Permalink to this headline">¶</a></h4> <p>Not all network adapters support setting link status. This command will succeed even if the network adapter does not support link status notification.</p> </div> <div class="section" id="qapidoc-1307"> <h4>Example<a class="headerlink" href="#qapidoc-1307" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"set_link"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"e1000.0"</span><span class="p">,</span> <span class="s2">"up"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1313"> <h3><a class="toc-backref" href="#id150"><code class="docutils literal notranslate"><span class="pre">netdev_add</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1313" title="Permalink to this headline">¶</a></h3> <p>Add a network backend.</p> <p>Additional arguments depend on the type.</p> <div class="section" id="qapidoc-1309"> <h4>Arguments<a class="headerlink" href="#qapidoc-1309" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">Netdev</span></code></dl> </div> <div class="section" id="qapidoc-1310"> <h4>Since<a class="headerlink" href="#qapidoc-1310" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1311"> <h4>Returns<a class="headerlink" href="#qapidoc-1311" title="Permalink to this headline">¶</a></h4> <p>Nothing on success If <code class="docutils literal notranslate"><span class="pre">type</span></code> is not a valid network backend, DeviceNotFound</p> </div> <div class="section" id="qapidoc-1312"> <h4>Example<a class="headerlink" href="#qapidoc-1312" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"netdev_add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"netdev1"</span><span class="p">,</span> <span class="s2">"dnssearch"</span><span class="p">:</span> <span class="s2">"example.org"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1318"> <h3><a class="toc-backref" href="#id151"><code class="docutils literal notranslate"><span class="pre">netdev_del</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1318" title="Permalink to this headline">¶</a></h3> <p>Remove a network backend.</p> <div class="section" id="qapidoc-1314"> <h4>Arguments<a class="headerlink" href="#qapidoc-1314" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the network backend to remove</dd> </dl> </div> <div class="section" id="qapidoc-1315"> <h4>Returns<a class="headerlink" href="#qapidoc-1315" title="Permalink to this headline">¶</a></h4> <p>Nothing on success If <code class="docutils literal notranslate"><span class="pre">id</span></code> is not a valid network backend, DeviceNotFound</p> </div> <div class="section" id="qapidoc-1316"> <h4>Since<a class="headerlink" href="#qapidoc-1316" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1317"> <h4>Example<a class="headerlink" href="#qapidoc-1317" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"netdev_del"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"netdev1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1321"> <h3><a class="toc-backref" href="#id152"><code class="docutils literal notranslate"><span class="pre">NetLegacyNicOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1321" title="Permalink to this headline">¶</a></h3> <p>Create a new Network Interface Card.</p> <div class="section" id="qapidoc-1319"> <h4>Members<a class="headerlink" href="#qapidoc-1319" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">netdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>id of -netdev to connect to</dd> <dt><code class="docutils literal notranslate"><span class="pre">macaddr</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>MAC address</dd> <dt><code class="docutils literal notranslate"><span class="pre">model</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device model (e1000, rtl8139, virtio etc.)</dd> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>PCI device address</dd> <dt><code class="docutils literal notranslate"><span class="pre">vectors</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of MSI-x vectors, 0 to disable MSI-X</dd> </dl> </div> <div class="section" id="qapidoc-1320"> <h4>Since<a class="headerlink" href="#qapidoc-1320" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1324"> <h3><a class="toc-backref" href="#id153"><code class="docutils literal notranslate"><span class="pre">NetdevUserOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1324" title="Permalink to this headline">¶</a></h3> <p>Use the user mode network stack which requires no administrator privilege to run.</p> <div class="section" id="qapidoc-1322"> <h4>Members<a class="headerlink" href="#qapidoc-1322" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">hostname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>client hostname reported by the builtin DHCP server</dd> <dt><code class="docutils literal notranslate"><span class="pre">restrict</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>isolate the guest from the host</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv4</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to support IPv4, default true for enabled (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to support IPv6, default true for enabled (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>legacy parameter, use net= instead</dd> <dt><code class="docutils literal notranslate"><span class="pre">net</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>IP network address that the guest will see, in the form addr[/netmask] The netmask is optional, and can be either in the form a.b.c.d or as a number of valid top-most bits. Default is 10.0.2.0/24.</dd> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest-visible address of the host</dd> <dt><code class="docutils literal notranslate"><span class="pre">tftp</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>root directory of the built-in TFTP server</dd> <dt><code class="docutils literal notranslate"><span class="pre">bootfile</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>BOOTP filename, for use with tftp=</dd> <dt><code class="docutils literal notranslate"><span class="pre">dhcpstart</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the first of the 16 IPs the built-in DHCP server can assign</dd> <dt><code class="docutils literal notranslate"><span class="pre">dns</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest-visible address of the virtual nameserver</dd> <dt><code class="docutils literal notranslate"><span class="pre">dnssearch</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">String</span></code> (optional)</dt> <dd>list of DNS suffixes to search, passed as DHCP option to the guest</dd> <dt><code class="docutils literal notranslate"><span class="pre">domainname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest-visible domain name of the virtual nameserver (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6-prefix</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>IPv6 network prefix (default is fec0::) (since 2.6). The network prefix is given in the usual hexadecimal IPv6 address notation.</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6-prefixlen</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>IPv6 network prefix length (default is 64) (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6-host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest-visible IPv6 address of the host (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6-dns</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest-visible IPv6 address of the virtual nameserver (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">smb</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>root directory of the built-in SMB server</dd> <dt><code class="docutils literal notranslate"><span class="pre">smbserver</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>IP address of the built-in SMB server</dd> <dt><code class="docutils literal notranslate"><span class="pre">hostfwd</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">String</span></code> (optional)</dt> <dd>redirect incoming TCP or UDP host connections to guest endpoints</dd> <dt><code class="docutils literal notranslate"><span class="pre">guestfwd</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">String</span></code> (optional)</dt> <dd>forward guest TCP connections</dd> <dt><code class="docutils literal notranslate"><span class="pre">tftp-server-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>RFC2132 “TFTP server name” string (Since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-1323"> <h4>Since<a class="headerlink" href="#qapidoc-1323" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1327"> <h3><a class="toc-backref" href="#id154"><code class="docutils literal notranslate"><span class="pre">NetdevTapOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1327" title="Permalink to this headline">¶</a></h3> <p>Used to configure a host TAP network interface backend.</p> <div class="section" id="qapidoc-1325"> <h4>Members<a class="headerlink" href="#qapidoc-1325" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ifname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>interface name</dd> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>file descriptor of an already opened tap</dd> <dt><code class="docutils literal notranslate"><span class="pre">fds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>multiple file descriptors of already opened multiqueue capable tap</dd> <dt><code class="docutils literal notranslate"><span class="pre">script</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>script to initialize the interface</dd> <dt><code class="docutils literal notranslate"><span class="pre">downscript</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>script to shut down the interface</dd> <dt><code class="docutils literal notranslate"><span class="pre">br</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>bridge name (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">helper</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>command to execute to configure bridge</dd> <dt><code class="docutils literal notranslate"><span class="pre">sndbuf</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>send buffer limit. Understands [TGMKkb] suffixes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vnet_hdr</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable the IFF_VNET_HDR flag on the tap interface</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhost</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enable vhost-net network accelerator</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhostfd</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>file descriptor of an already opened vhost net device</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhostfds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>file descriptors of multiple already opened vhost net devices</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhostforce</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>vhost on for non-MSIX virtio guests</dd> <dt><code class="docutils literal notranslate"><span class="pre">queues</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of queues to be created for multiqueue capable tap</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-us</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum number of microseconds that could be spent on busy polling for tap (since 2.7)</dd> </dl> </div> <div class="section" id="qapidoc-1326"> <h4>Since<a class="headerlink" href="#qapidoc-1326" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1330"> <h3><a class="toc-backref" href="#id155"><code class="docutils literal notranslate"><span class="pre">NetdevSocketOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1330" title="Permalink to this headline">¶</a></h3> <p>Socket netdevs are used to establish a network connection to another QEMU virtual machine via a TCP socket.</p> <div class="section" id="qapidoc-1328"> <h4>Members<a class="headerlink" href="#qapidoc-1328" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>file descriptor of an already opened socket</dd> <dt><code class="docutils literal notranslate"><span class="pre">listen</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>port number, and optional hostname, to listen on</dd> <dt><code class="docutils literal notranslate"><span class="pre">connect</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>port number, and optional hostname, to connect to</dd> <dt><code class="docutils literal notranslate"><span class="pre">mcast</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>UDP multicast address and port number</dd> <dt><code class="docutils literal notranslate"><span class="pre">localaddr</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>source address and port for multicast and udp packets</dd> <dt><code class="docutils literal notranslate"><span class="pre">udp</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>UDP unicast address and port number</dd> </dl> </div> <div class="section" id="qapidoc-1329"> <h4>Since<a class="headerlink" href="#qapidoc-1329" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1333"> <h3><a class="toc-backref" href="#id156"><code class="docutils literal notranslate"><span class="pre">NetdevL2TPv3Options</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1333" title="Permalink to this headline">¶</a></h3> <p>Configure an Ethernet over L2TPv3 tunnel.</p> <div class="section" id="qapidoc-1331"> <h4>Members<a class="headerlink" href="#qapidoc-1331" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">src</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>source address</dd> <dt><code class="docutils literal notranslate"><span class="pre">dst</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>destination address</dd> <dt><code class="docutils literal notranslate"><span class="pre">srcport</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>source port - mandatory for udp, optional for ip</dd> <dt><code class="docutils literal notranslate"><span class="pre">dstport</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>destination port - mandatory for udp, optional for ip</dd> <dt><code class="docutils literal notranslate"><span class="pre">ipv6</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>force the use of ipv6</dd> <dt><code class="docutils literal notranslate"><span class="pre">udp</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>use the udp version of l2tpv3 encapsulation</dd> <dt><code class="docutils literal notranslate"><span class="pre">cookie64</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>use 64 bit coookies</dd> <dt><code class="docutils literal notranslate"><span class="pre">counter</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>have sequence counter</dd> <dt><code class="docutils literal notranslate"><span class="pre">pincounter</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>pin sequence counter to zero - workaround for buggy implementations or networks with packet reorder</dd> <dt><code class="docutils literal notranslate"><span class="pre">txcookie</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>32 or 64 bit transmit cookie</dd> <dt><code class="docutils literal notranslate"><span class="pre">rxcookie</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>32 or 64 bit receive cookie</dd> <dt><code class="docutils literal notranslate"><span class="pre">txsession</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>32 bit transmit session</dd> <dt><code class="docutils literal notranslate"><span class="pre">rxsession</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>32 bit receive session - if not specified set to the same value as transmit</dd> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>additional offset - allows the insertion of additional application-specific data before the packet payload</dd> </dl> </div> <div class="section" id="qapidoc-1332"> <h4>Since<a class="headerlink" href="#qapidoc-1332" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-1336"> <h3><a class="toc-backref" href="#id157"><code class="docutils literal notranslate"><span class="pre">NetdevVdeOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1336" title="Permalink to this headline">¶</a></h3> <p>Connect to a vde switch running on the host.</p> <div class="section" id="qapidoc-1334"> <h4>Members<a class="headerlink" href="#qapidoc-1334" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sock</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>socket path</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>port number</dd> <dt><code class="docutils literal notranslate"><span class="pre">group</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>group owner of socket</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>permissions for socket</dd> </dl> </div> <div class="section" id="qapidoc-1335"> <h4>Since<a class="headerlink" href="#qapidoc-1335" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1339"> <h3><a class="toc-backref" href="#id158"><code class="docutils literal notranslate"><span class="pre">NetdevBridgeOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1339" title="Permalink to this headline">¶</a></h3> <p>Connect a host TAP network interface to a host bridge device.</p> <div class="section" id="qapidoc-1337"> <h4>Members<a class="headerlink" href="#qapidoc-1337" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">br</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>bridge name</dd> <dt><code class="docutils literal notranslate"><span class="pre">helper</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>command to execute to configure bridge</dd> </dl> </div> <div class="section" id="qapidoc-1338"> <h4>Since<a class="headerlink" href="#qapidoc-1338" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1342"> <h3><a class="toc-backref" href="#id159"><code class="docutils literal notranslate"><span class="pre">NetdevHubPortOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1342" title="Permalink to this headline">¶</a></h3> <p>Connect two or more net clients through a software hub.</p> <div class="section" id="qapidoc-1340"> <h4>Members<a class="headerlink" href="#qapidoc-1340" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">hubid</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>hub identifier number</dd> <dt><code class="docutils literal notranslate"><span class="pre">netdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>used to connect hub to a netdev instead of a device (since 2.12)</dd> </dl> </div> <div class="section" id="qapidoc-1341"> <h4>Since<a class="headerlink" href="#qapidoc-1341" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1345"> <h3><a class="toc-backref" href="#id160"><code class="docutils literal notranslate"><span class="pre">NetdevNetmapOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1345" title="Permalink to this headline">¶</a></h3> <p>Connect a client to a netmap-enabled NIC or to a VALE switch port</p> <div class="section" id="qapidoc-1343"> <h4>Members<a class="headerlink" href="#qapidoc-1343" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">ifname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Either the name of an existing network interface supported by netmap, or the name of a VALE port (created on the fly). A VALE port name is in the form ‘valeXXX:YYY’, where XXX and YYY are non-negative integers. XXX identifies a switch and YYY identifies a port of the switch. VALE ports having the same XXX are therefore connected to the same switch.</dd> <dt><code class="docutils literal notranslate"><span class="pre">devname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>path of the netmap device (default: ‘/dev/netmap’).</dd> </dl> </div> <div class="section" id="qapidoc-1344"> <h4>Since<a class="headerlink" href="#qapidoc-1344" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1348"> <h3><a class="toc-backref" href="#id161"><code class="docutils literal notranslate"><span class="pre">NetdevVhostUserOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1348" title="Permalink to this headline">¶</a></h3> <p>Vhost-user network backend</p> <div class="section" id="qapidoc-1346"> <h4>Members<a class="headerlink" href="#qapidoc-1346" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of a unix socket chardev</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhostforce</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>vhost on for non-MSIX virtio guests (default: false).</dd> <dt><code class="docutils literal notranslate"><span class="pre">queues</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of queues to be created for multiqueue vhost-user (default: 1) (Since 2.5)</dd> </dl> </div> <div class="section" id="qapidoc-1347"> <h4>Since<a class="headerlink" href="#qapidoc-1347" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-1351"> <h3><a class="toc-backref" href="#id162"><code class="docutils literal notranslate"><span class="pre">NetdevVhostVDPAOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1351" title="Permalink to this headline">¶</a></h3> <p>Vhost-vdpa network backend</p> <p>vDPA device is a device that uses a datapath which complies with the virtio specifications with a vendor specific control path.</p> <div class="section" id="qapidoc-1349"> <h4>Members<a class="headerlink" href="#qapidoc-1349" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">vhostdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>path of vhost-vdpa device (default:’/dev/vhost-vdpa-0’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">queues</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of queues to be created for multiqueue vhost-vdpa (default: 1)</dd> </dl> </div> <div class="section" id="qapidoc-1350"> <h4>Since<a class="headerlink" href="#qapidoc-1350" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-1354"> <h3><a class="toc-backref" href="#id163"><code class="docutils literal notranslate"><span class="pre">NetClientDriver</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1354" title="Permalink to this headline">¶</a></h3> <p>Available netdev drivers.</p> <div class="section" id="qapidoc-1352"> <h4>Values<a class="headerlink" href="#qapidoc-1352" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">nic</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">user</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tap</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l2tpv3</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">socket</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vde</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">bridge</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">hubport</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">netmap</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhost-user</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vhost-vdpa</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1353"> <h4>Since<a class="headerlink" href="#qapidoc-1353" title="Permalink to this headline">¶</a></h4> <p>2.7</p> <p><code class="docutils literal notranslate"><span class="pre">vhost-vdpa</span></code> since 5.1</p> </div> </div> <div class="section" id="qapidoc-1357"> <h3><a class="toc-backref" href="#id164"><code class="docutils literal notranslate"><span class="pre">Netdev</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1357" title="Permalink to this headline">¶</a></h3> <p>Captures the configuration of a network device.</p> <div class="section" id="qapidoc-1355"> <h4>Members<a class="headerlink" href="#qapidoc-1355" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>identifier for monitor commands.</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">NetClientDriver</span></code></dt> <dd>Specify the driver used for interpreting remaining arguments.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetLegacyNicOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"nic"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevUserOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"user"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevTapOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"tap"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevL2TPv3Options</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"l2tpv3"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevSocketOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"socket"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevVdeOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vde"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevBridgeOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"bridge"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevHubPortOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"hubport"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevNetmapOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"netmap"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevVhostUserOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vhost-user"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetdevVhostVDPAOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vhost-vdpa"</span></code></dl> </div> <div class="section" id="qapidoc-1356"> <h4>Since<a class="headerlink" href="#qapidoc-1356" title="Permalink to this headline">¶</a></h4> <p>1.2</p> <p>‘l2tpv3’ - since 2.1</p> </div> </div> <div class="section" id="qapidoc-1360"> <h3><a class="toc-backref" href="#id165"><code class="docutils literal notranslate"><span class="pre">RxState</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1360" title="Permalink to this headline">¶</a></h3> <p>Packets receiving state</p> <div class="section" id="qapidoc-1358"> <h4>Values<a class="headerlink" href="#qapidoc-1358" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">normal</span></code></dt> <dd>filter assigned packets according to the mac-table</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>don’t receive any assigned packet</dd> <dt><code class="docutils literal notranslate"><span class="pre">all</span></code></dt> <dd>receive all assigned packets</dd> </dl> </div> <div class="section" id="qapidoc-1359"> <h4>Since<a class="headerlink" href="#qapidoc-1359" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-1363"> <h3><a class="toc-backref" href="#id166"><code class="docutils literal notranslate"><span class="pre">RxFilterInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1363" title="Permalink to this headline">¶</a></h3> <p>Rx-filter information for a NIC.</p> <div class="section" id="qapidoc-1361"> <h4>Members<a class="headerlink" href="#qapidoc-1361" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>net client name</dd> <dt><code class="docutils literal notranslate"><span class="pre">promiscuous</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether promiscuous mode is enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">multicast</span></code>: <code class="docutils literal notranslate"><span class="pre">RxState</span></code></dt> <dd>multicast receive state</dd> <dt><code class="docutils literal notranslate"><span class="pre">unicast</span></code>: <code class="docutils literal notranslate"><span class="pre">RxState</span></code></dt> <dd>unicast receive state</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan</span></code>: <code class="docutils literal notranslate"><span class="pre">RxState</span></code></dt> <dd>vlan receive state (Since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">broadcast-allowed</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether to receive broadcast</dd> <dt><code class="docutils literal notranslate"><span class="pre">multicast-overflow</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>multicast table is overflowed or not</dd> <dt><code class="docutils literal notranslate"><span class="pre">unicast-overflow</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>unicast table is overflowed or not</dd> <dt><code class="docutils literal notranslate"><span class="pre">main-mac</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the main macaddr string</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan-table</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code></dt> <dd>a list of active vlan id</dd> <dt><code class="docutils literal notranslate"><span class="pre">unicast-table</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>a list of unicast macaddr string</dd> <dt><code class="docutils literal notranslate"><span class="pre">multicast-table</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>a list of multicast macaddr string</dd> </dl> </div> <div class="section" id="qapidoc-1362"> <h4>Since<a class="headerlink" href="#qapidoc-1362" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-1368"> <h3><a class="toc-backref" href="#id167"><code class="docutils literal notranslate"><span class="pre">query-rx-filter</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1368" title="Permalink to this headline">¶</a></h3> <p>Return rx-filter information for all NICs (or for the given NIC).</p> <div class="section" id="qapidoc-1364"> <h4>Arguments<a class="headerlink" href="#qapidoc-1364" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>net client name</dd> </dl> </div> <div class="section" id="qapidoc-1365"> <h4>Returns<a class="headerlink" href="#qapidoc-1365" title="Permalink to this headline">¶</a></h4> <p>list of <code class="docutils literal notranslate"><span class="pre">RxFilterInfo</span></code> for all NICs (or for the given NIC). Returns an error if the given <code class="docutils literal notranslate"><span class="pre">name</span></code> doesn’t exist, or given NIC doesn’t support rx-filter querying, or given net client isn’t a NIC.</p> </div> <div class="section" id="qapidoc-1366"> <h4>Since<a class="headerlink" href="#qapidoc-1366" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> <div class="section" id="qapidoc-1367"> <h4>Example<a class="headerlink" href="#qapidoc-1367" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-rx-filter"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"vnet0"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"promiscuous"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"vnet0"</span><span class="p">,</span> <span class="s2">"main-mac"</span><span class="p">:</span> <span class="s2">"52:54:00:12:34:56"</span><span class="p">,</span> <span class="s2">"unicast"</span><span class="p">:</span> <span class="s2">"normal"</span><span class="p">,</span> <span class="s2">"vlan"</span><span class="p">:</span> <span class="s2">"normal"</span><span class="p">,</span> <span class="s2">"vlan-table"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">0</span> <span class="p">],</span> <span class="s2">"unicast-table"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span> <span class="s2">"multicast"</span><span class="p">:</span> <span class="s2">"normal"</span><span class="p">,</span> <span class="s2">"multicast-overflow"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"unicast-overflow"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"multicast-table"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"01:00:5e:00:00:01"</span><span class="p">,</span> <span class="s2">"33:33:00:00:00:01"</span><span class="p">,</span> <span class="s2">"33:33:ff:12:34:56"</span> <span class="p">],</span> <span class="s2">"broadcast-allowed"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1372"> <h3><a class="toc-backref" href="#id168"><code class="docutils literal notranslate"><span class="pre">NIC_RX_FILTER_CHANGED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1372" title="Permalink to this headline">¶</a></h3> <p>Emitted once until the ‘query-rx-filter’ command is executed, the first event will always be emitted</p> <div class="section" id="qapidoc-1369"> <h4>Arguments<a class="headerlink" href="#qapidoc-1369" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>net client name</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device path</dd> </dl> </div> <div class="section" id="qapidoc-1370"> <h4>Since<a class="headerlink" href="#qapidoc-1370" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> <div class="section" id="qapidoc-1371"> <h4>Example<a class="headerlink" href="#qapidoc-1371" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"NIC_RX_FILTER_CHANGED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"vnet0"</span><span class="p">,</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/machine/peripheral/vnet0/virtio-backend"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1368697518</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">326866</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1375"> <h3><a class="toc-backref" href="#id169"><code class="docutils literal notranslate"><span class="pre">AnnounceParameters</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1375" title="Permalink to this headline">¶</a></h3> <p>Parameters for self-announce timers</p> <div class="section" id="qapidoc-1373"> <h4>Members<a class="headerlink" href="#qapidoc-1373" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">initial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Initial delay (in ms) before sending the first GARP/RARP announcement</dd> <dt><code class="docutils literal notranslate"><span class="pre">max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Maximum delay (in ms) between GARP/RARP announcement packets</dd> <dt><code class="docutils literal notranslate"><span class="pre">rounds</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of self-announcement attempts</dd> <dt><code class="docutils literal notranslate"><span class="pre">step</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Delay increase (in ms) after each self-announcement attempt</dd> <dt><code class="docutils literal notranslate"><span class="pre">interfaces</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>An optional list of interface names, which restricts the announcement to the listed interfaces. (Since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>A name to be used to identify an instance of announce-timers and to allow it to modified later. Not for use as part of the migration parameters. (Since 4.1)</dd> </dl> </div> <div class="section" id="qapidoc-1374"> <h4>Since<a class="headerlink" href="#qapidoc-1374" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1379"> <h3><a class="toc-backref" href="#id170"><code class="docutils literal notranslate"><span class="pre">announce-self</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1379" title="Permalink to this headline">¶</a></h3> <p>Trigger generation of broadcast RARP frames to update network switches. This can be useful when network bonds fail-over the active slave.</p> <div class="section" id="qapidoc-1376"> <h4>Arguments<a class="headerlink" href="#qapidoc-1376" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AnnounceParameters</span></code></dl> </div> <div class="section" id="qapidoc-1377"> <h4>Example<a class="headerlink" href="#qapidoc-1377" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"announce-self"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"initial"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span> <span class="s2">"max"</span><span class="p">:</span> <span class="mi">550</span><span class="p">,</span> <span class="s2">"rounds"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> <span class="s2">"step"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span> <span class="s2">"interfaces"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"vn2"</span><span class="p">,</span> <span class="s2">"vn3"</span><span class="p">],</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"bob"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1378"> <h4>Since<a class="headerlink" href="#qapidoc-1378" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1383"> <h3><a class="toc-backref" href="#id171"><code class="docutils literal notranslate"><span class="pre">FAILOVER_NEGOTIATED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1383" title="Permalink to this headline">¶</a></h3> <p>Emitted when VIRTIO_NET_F_STANDBY was enabled during feature negotiation. Failover primary devices which were hidden (not hotplugged when requested) before will now be hotplugged by the virtio-net standby device.</p> <p>device-id: QEMU device id of the unplugged device</p> <div class="section" id="qapidoc-1380"> <h4>Arguments<a class="headerlink" href="#qapidoc-1380" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1381"> <h4>Since<a class="headerlink" href="#qapidoc-1381" title="Permalink to this headline">¶</a></h4> <p>4.2</p> </div> <div class="section" id="qapidoc-1382"> <h4>Example<a class="headerlink" href="#qapidoc-1382" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"FAILOVER_NEGOTIATED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"net1"</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1384"> <h2><a class="toc-backref" href="#id172">RDMA device</a><a class="headerlink" href="#qapidoc-1384" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1389"> <h3><a class="toc-backref" href="#id173"><code class="docutils literal notranslate"><span class="pre">RDMA_GID_STATUS_CHANGED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1389" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest driver adds/deletes GID to/from device</p> <div class="section" id="qapidoc-1385"> <h4>Arguments<a class="headerlink" href="#qapidoc-1385" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">netdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>RoCE Network Device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">gid-status</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Add or delete indication</dd> <dt><code class="docutils literal notranslate"><span class="pre">subnet-prefix</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Subnet Prefix</dd> <dt><code class="docutils literal notranslate"><span class="pre">interface-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1386"> <code class="docutils literal notranslate"><span class="pre">interface-id</span></code> : Interface ID</div> <div class="section" id="qapidoc-1387"> <h4>Since<a class="headerlink" href="#qapidoc-1387" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> <div class="section" id="qapidoc-1388"> <h4>Example<a class="headerlink" href="#qapidoc-1388" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span><span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1541579657</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">986760</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RDMA_GID_STATUS_CHANGED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"netdev"</span><span class="p">:</span> <span class="s2">"bridge0"</span><span class="p">,</span> <span class="s2">"interface-id"</span><span class="p">:</span> <span class="mi">15880512517475447892</span><span class="p">,</span> <span class="s2">"gid-status"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"subnet-prefix"</span><span class="p">:</span> <span class="mi">33022</span><span class="p">}}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1390"> <h2><a class="toc-backref" href="#id174">Rocker switch device</a><a class="headerlink" href="#qapidoc-1390" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1393"> <h3><a class="toc-backref" href="#id175"><code class="docutils literal notranslate"><span class="pre">RockerSwitch</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1393" title="Permalink to this headline">¶</a></h3> <p>Rocker switch information.</p> <div class="section" id="qapidoc-1391"> <h4>Members<a class="headerlink" href="#qapidoc-1391" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>switch name</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>switch ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">ports</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of front-panel ports</dd> </dl> </div> <div class="section" id="qapidoc-1392"> <h4>Since<a class="headerlink" href="#qapidoc-1392" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1398"> <h3><a class="toc-backref" href="#id176"><code class="docutils literal notranslate"><span class="pre">query-rocker</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1398" title="Permalink to this headline">¶</a></h3> <p>Return rocker switch information.</p> <div class="section" id="qapidoc-1394"> <h4>Arguments<a class="headerlink" href="#qapidoc-1394" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1395"> <h4>Returns<a class="headerlink" href="#qapidoc-1395" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">Rocker</span></code> information</p> </div> <div class="section" id="qapidoc-1396"> <h4>Since<a class="headerlink" href="#qapidoc-1396" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1397"> <h4>Example<a class="headerlink" href="#qapidoc-1397" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-rocker"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1"</span><span class="p">,</span> <span class="s2">"ports"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">1327446905938</span><span class="p">}}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1401"> <h3><a class="toc-backref" href="#id177"><code class="docutils literal notranslate"><span class="pre">RockerPortDuplex</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1401" title="Permalink to this headline">¶</a></h3> <p>An eumeration of port duplex states.</p> <div class="section" id="qapidoc-1399"> <h4>Values<a class="headerlink" href="#qapidoc-1399" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">half</span></code></dt> <dd>half duplex</dd> <dt><code class="docutils literal notranslate"><span class="pre">full</span></code></dt> <dd>full duplex</dd> </dl> </div> <div class="section" id="qapidoc-1400"> <h4>Since<a class="headerlink" href="#qapidoc-1400" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1404"> <h3><a class="toc-backref" href="#id178"><code class="docutils literal notranslate"><span class="pre">RockerPortAutoneg</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1404" title="Permalink to this headline">¶</a></h3> <p>An eumeration of port autoneg states.</p> <div class="section" id="qapidoc-1402"> <h4>Values<a class="headerlink" href="#qapidoc-1402" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>autoneg is off</dd> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>autoneg is on</dd> </dl> </div> <div class="section" id="qapidoc-1403"> <h4>Since<a class="headerlink" href="#qapidoc-1403" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1407"> <h3><a class="toc-backref" href="#id179"><code class="docutils literal notranslate"><span class="pre">RockerPort</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1407" title="Permalink to this headline">¶</a></h3> <p>Rocker switch port information.</p> <div class="section" id="qapidoc-1405"> <h4>Members<a class="headerlink" href="#qapidoc-1405" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>port name</dd> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>port is enabled for I/O</dd> <dt><code class="docutils literal notranslate"><span class="pre">link-up</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>physical link is UP on port</dd> <dt><code class="docutils literal notranslate"><span class="pre">speed</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>port link speed in Mbps</dd> <dt><code class="docutils literal notranslate"><span class="pre">duplex</span></code>: <code class="docutils literal notranslate"><span class="pre">RockerPortDuplex</span></code></dt> <dd>port link duplex</dd> <dt><code class="docutils literal notranslate"><span class="pre">autoneg</span></code>: <code class="docutils literal notranslate"><span class="pre">RockerPortAutoneg</span></code></dt> <dd>port link autoneg</dd> </dl> </div> <div class="section" id="qapidoc-1406"> <h4>Since<a class="headerlink" href="#qapidoc-1406" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1412"> <h3><a class="toc-backref" href="#id180"><code class="docutils literal notranslate"><span class="pre">query-rocker-ports</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1412" title="Permalink to this headline">¶</a></h3> <p>Return rocker switch port information.</p> <div class="section" id="qapidoc-1408"> <h4>Arguments<a class="headerlink" href="#qapidoc-1408" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1409"> <h4>Returns<a class="headerlink" href="#qapidoc-1409" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">RockerPort</span></code> information</p> </div> <div class="section" id="qapidoc-1410"> <h4>Since<a class="headerlink" href="#qapidoc-1410" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1411"> <h4>Example<a class="headerlink" href="#qapidoc-1411" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-rocker-ports"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="s2">"duplex"</span><span class="p">:</span> <span class="s2">"full"</span><span class="p">,</span> <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1.1"</span><span class="p">,</span> <span class="s2">"autoneg"</span><span class="p">:</span> <span class="s2">"off"</span><span class="p">,</span> <span class="s2">"link-up"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"speed"</span><span class="p">:</span> <span class="mi">10000</span><span class="p">},</span> <span class="p">{</span><span class="s2">"duplex"</span><span class="p">:</span> <span class="s2">"full"</span><span class="p">,</span> <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1.2"</span><span class="p">,</span> <span class="s2">"autoneg"</span><span class="p">:</span> <span class="s2">"off"</span><span class="p">,</span> <span class="s2">"link-up"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"speed"</span><span class="p">:</span> <span class="mi">10000</span><span class="p">}</span> <span class="p">]}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1416"> <h3><a class="toc-backref" href="#id181"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowKey</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1416" title="Permalink to this headline">¶</a></h3> <p>Rocker switch OF-DPA flow key</p> <div class="section" id="qapidoc-1413"> <h4>Members<a class="headerlink" href="#qapidoc-1413" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">priority</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>key priority, 0 being lowest priority</dd> <dt><code class="docutils literal notranslate"><span class="pre">tbl-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>flow table ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">in-pport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>physical input port</dd> <dt><code class="docutils literal notranslate"><span class="pre">tunnel-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>tunnel ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>VLAN ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">eth-type</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Ethernet header type</dd> <dt><code class="docutils literal notranslate"><span class="pre">eth-src</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ethernet header source MAC address</dd> <dt><code class="docutils literal notranslate"><span class="pre">eth-dst</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ethernet header destination MAC address</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip-proto</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>IP Header protocol field</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip-tos</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>IP header TOS field</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip-dst</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>IP header destination address</dd> </dl> </div> <div class="section" id="qapidoc-1414"> <h4>Note<a class="headerlink" href="#qapidoc-1414" title="Permalink to this headline">¶</a></h4> <p>optional members may or may not appear in the flow key depending if they’re relevant to the flow key.</p> </div> <div class="section" id="qapidoc-1415"> <h4>Since<a class="headerlink" href="#qapidoc-1415" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1420"> <h3><a class="toc-backref" href="#id182"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowMask</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1420" title="Permalink to this headline">¶</a></h3> <p>Rocker switch OF-DPA flow mask</p> <div class="section" id="qapidoc-1417"> <h4>Members<a class="headerlink" href="#qapidoc-1417" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in-pport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>physical input port</dd> <dt><code class="docutils literal notranslate"><span class="pre">tunnel-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>tunnel ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>VLAN ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">eth-src</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ethernet header source MAC address</dd> <dt><code class="docutils literal notranslate"><span class="pre">eth-dst</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Ethernet header destination MAC address</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip-proto</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>IP Header protocol field</dd> <dt><code class="docutils literal notranslate"><span class="pre">ip-tos</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>IP header TOS field</dd> </dl> </div> <div class="section" id="qapidoc-1418"> <h4>Note<a class="headerlink" href="#qapidoc-1418" title="Permalink to this headline">¶</a></h4> <p>optional members may or may not appear in the flow mask depending if they’re relevant to the flow mask.</p> </div> <div class="section" id="qapidoc-1419"> <h4>Since<a class="headerlink" href="#qapidoc-1419" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1424"> <h3><a class="toc-backref" href="#id183"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowAction</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1424" title="Permalink to this headline">¶</a></h3> <p>Rocker switch OF-DPA flow action</p> <div class="section" id="qapidoc-1421"> <h4>Members<a class="headerlink" href="#qapidoc-1421" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">goto-tbl</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>next table ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">group-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>group ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">tunnel-lport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>tunnel logical port ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>VLAN ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">new-vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>new VLAN ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">out-pport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>physical output port</dd> </dl> </div> <div class="section" id="qapidoc-1422"> <h4>Note<a class="headerlink" href="#qapidoc-1422" title="Permalink to this headline">¶</a></h4> <p>optional members may or may not appear in the flow action depending if they’re relevant to the flow action.</p> </div> <div class="section" id="qapidoc-1423"> <h4>Since<a class="headerlink" href="#qapidoc-1423" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1427"> <h3><a class="toc-backref" href="#id184"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlow</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1427" title="Permalink to this headline">¶</a></h3> <p>Rocker switch OF-DPA flow</p> <div class="section" id="qapidoc-1425"> <h4>Members<a class="headerlink" href="#qapidoc-1425" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cookie</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>flow unique cookie ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">hits</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>count of matches (hits) on flow</dd> <dt><code class="docutils literal notranslate"><span class="pre">key</span></code>: <code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowKey</span></code></dt> <dd>flow key</dd> <dt><code class="docutils literal notranslate"><span class="pre">mask</span></code>: <code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowMask</span></code></dt> <dd>flow mask</dd> <dt><code class="docutils literal notranslate"><span class="pre">action</span></code>: <code class="docutils literal notranslate"><span class="pre">RockerOfDpaFlowAction</span></code></dt> <dd>flow action</dd> </dl> </div> <div class="section" id="qapidoc-1426"> <h4>Since<a class="headerlink" href="#qapidoc-1426" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1432"> <h3><a class="toc-backref" href="#id185"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-flows</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1432" title="Permalink to this headline">¶</a></h3> <p>Return rocker OF-DPA flow information.</p> <div class="section" id="qapidoc-1428"> <h4>Arguments<a class="headerlink" href="#qapidoc-1428" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>switch name</dd> <dt><code class="docutils literal notranslate"><span class="pre">tbl-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>flow table ID. If tbl-id is not specified, returns flow information for all tables.</dd> </dl> </div> <div class="section" id="qapidoc-1429"> <h4>Returns<a class="headerlink" href="#qapidoc-1429" title="Permalink to this headline">¶</a></h4> <p>rocker OF-DPA flow information</p> </div> <div class="section" id="qapidoc-1430"> <h4>Since<a class="headerlink" href="#qapidoc-1430" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1431"> <h4>Example<a class="headerlink" href="#qapidoc-1431" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-rocker-of-dpa-flows"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="s2">"key"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"in-pport"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"priority"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"tbl-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="s2">"hits"</span><span class="p">:</span> <span class="mi">138</span><span class="p">,</span> <span class="s2">"cookie"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"action"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"goto-tbl"</span><span class="p">:</span> <span class="mi">10</span><span class="p">},</span> <span class="s2">"mask"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"in-pport"</span><span class="p">:</span> <span class="mi">4294901760</span><span class="p">}</span> <span class="p">},</span> <span class="p">{</span><span class="o">...</span><span class="n">more</span><span class="o">...</span><span class="p">},</span> <span class="p">]}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1436"> <h3><a class="toc-backref" href="#id186"><code class="docutils literal notranslate"><span class="pre">RockerOfDpaGroup</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1436" title="Permalink to this headline">¶</a></h3> <p>Rocker switch OF-DPA group</p> <div class="section" id="qapidoc-1433"> <h4>Members<a class="headerlink" href="#qapidoc-1433" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>group unique ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>group type</dd> <dt><code class="docutils literal notranslate"><span class="pre">vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>VLAN ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">pport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>physical port number</dd> <dt><code class="docutils literal notranslate"><span class="pre">index</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>group index, unique with group type</dd> <dt><code class="docutils literal notranslate"><span class="pre">out-pport</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>output physical port number</dd> <dt><code class="docutils literal notranslate"><span class="pre">group-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>next group ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">set-vlan-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>VLAN ID to set</dd> <dt><code class="docutils literal notranslate"><span class="pre">pop-vlan</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>pop VLAN headr from packet</dd> <dt><code class="docutils literal notranslate"><span class="pre">group-ids</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of next group IDs</dd> <dt><code class="docutils literal notranslate"><span class="pre">set-eth-src</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>set source MAC address in Ethernet header</dd> <dt><code class="docutils literal notranslate"><span class="pre">set-eth-dst</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>set destination MAC address in Ethernet header</dd> <dt><code class="docutils literal notranslate"><span class="pre">ttl-check</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>perform TTL check</dd> </dl> </div> <div class="section" id="qapidoc-1434"> <h4>Note<a class="headerlink" href="#qapidoc-1434" title="Permalink to this headline">¶</a></h4> <p>optional members may or may not appear in the group depending if they’re relevant to the group type.</p> </div> <div class="section" id="qapidoc-1435"> <h4>Since<a class="headerlink" href="#qapidoc-1435" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1441"> <h3><a class="toc-backref" href="#id187"><code class="docutils literal notranslate"><span class="pre">query-rocker-of-dpa-groups</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1441" title="Permalink to this headline">¶</a></h3> <p>Return rocker OF-DPA group information.</p> <div class="section" id="qapidoc-1437"> <h4>Arguments<a class="headerlink" href="#qapidoc-1437" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>switch name</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>group type. If type is not specified, returns group information for all group types.</dd> </dl> </div> <div class="section" id="qapidoc-1438"> <h4>Returns<a class="headerlink" href="#qapidoc-1438" title="Permalink to this headline">¶</a></h4> <p>rocker OF-DPA group information</p> </div> <div class="section" id="qapidoc-1439"> <h4>Since<a class="headerlink" href="#qapidoc-1439" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1440"> <h4>Example<a class="headerlink" href="#qapidoc-1440" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-rocker-of-dpa-groups"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"sw1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"out-pport"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"pport"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"vlan-id"</span><span class="p">:</span> <span class="mi">3841</span><span class="p">,</span> <span class="s2">"pop-vlan"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">251723778</span><span class="p">},</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"out-pport"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"pport"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"vlan-id"</span><span class="p">:</span> <span class="mi">3841</span><span class="p">,</span> <span class="s2">"pop-vlan"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">251723776</span><span class="p">},</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"out-pport"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"pport"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"vlan-id"</span><span class="p">:</span> <span class="mi">3840</span><span class="p">,</span> <span class="s2">"pop-vlan"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">251658241</span><span class="p">},</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"out-pport"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"pport"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"vlan-id"</span><span class="p">:</span> <span class="mi">3840</span><span class="p">,</span> <span class="s2">"pop-vlan"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="mi">251658240</span><span class="p">}</span> <span class="p">]}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1442"> <h2><a class="toc-backref" href="#id188">TPM (trusted platform module) devices</a><a class="headerlink" href="#qapidoc-1442" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1446"> <h3><a class="toc-backref" href="#id189"><code class="docutils literal notranslate"><span class="pre">TpmModel</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1446" title="Permalink to this headline">¶</a></h3> <p>An enumeration of TPM models</p> <div class="section" id="qapidoc-1443"> <h4>Values<a class="headerlink" href="#qapidoc-1443" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">tpm-tis</span></code></dt> <dd>TPM TIS model</dd> <dt><code class="docutils literal notranslate"><span class="pre">tpm-crb</span></code></dt> <dd>TPM CRB model (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tpm-spapr</span></code></dt> <dd>TPM SPAPR model (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-1444"> <h4>Since<a class="headerlink" href="#qapidoc-1444" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1445"> <h4>If<a class="headerlink" href="#qapidoc-1445" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1451"> <h3><a class="toc-backref" href="#id190"><code class="docutils literal notranslate"><span class="pre">query-tpm-models</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1451" title="Permalink to this headline">¶</a></h3> <p>Return a list of supported TPM models</p> <div class="section" id="qapidoc-1447"> <h4>Returns<a class="headerlink" href="#qapidoc-1447" title="Permalink to this headline">¶</a></h4> <p>a list of TpmModel</p> </div> <div class="section" id="qapidoc-1448"> <h4>Since<a class="headerlink" href="#qapidoc-1448" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1449"> <h4>Example<a class="headerlink" href="#qapidoc-1449" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-tpm-models"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"tpm-tis"</span><span class="p">,</span> <span class="s2">"tpm-crb"</span><span class="p">,</span> <span class="s2">"tpm-spapr"</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1450"> <h4>If<a class="headerlink" href="#qapidoc-1450" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1455"> <h3><a class="toc-backref" href="#id191"><code class="docutils literal notranslate"><span class="pre">TpmType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1455" title="Permalink to this headline">¶</a></h3> <p>An enumeration of TPM types</p> <div class="section" id="qapidoc-1452"> <h4>Values<a class="headerlink" href="#qapidoc-1452" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">passthrough</span></code></dt> <dd>TPM passthrough type</dd> <dt><code class="docutils literal notranslate"><span class="pre">emulator</span></code></dt> <dd>Software Emulator TPM type Since: 2.11</dd> </dl> </div> <div class="section" id="qapidoc-1453"> <h4>Since<a class="headerlink" href="#qapidoc-1453" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1454"> <h4>If<a class="headerlink" href="#qapidoc-1454" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1460"> <h3><a class="toc-backref" href="#id192"><code class="docutils literal notranslate"><span class="pre">query-tpm-types</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1460" title="Permalink to this headline">¶</a></h3> <p>Return a list of supported TPM types</p> <div class="section" id="qapidoc-1456"> <h4>Returns<a class="headerlink" href="#qapidoc-1456" title="Permalink to this headline">¶</a></h4> <p>a list of TpmType</p> </div> <div class="section" id="qapidoc-1457"> <h4>Since<a class="headerlink" href="#qapidoc-1457" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1458"> <h4>Example<a class="headerlink" href="#qapidoc-1458" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-tpm-types"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"passthrough"</span><span class="p">,</span> <span class="s2">"emulator"</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1459"> <h4>If<a class="headerlink" href="#qapidoc-1459" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1464"> <h3><a class="toc-backref" href="#id193"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1464" title="Permalink to this headline">¶</a></h3> <p>Information about the TPM passthrough type</p> <div class="section" id="qapidoc-1461"> <h4>Members<a class="headerlink" href="#qapidoc-1461" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>string describing the path used for accessing the TPM device</dd> <dt><code class="docutils literal notranslate"><span class="pre">cancel-path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>string showing the TPM’s sysfs cancel file for cancellation of TPM commands while they are executing</dd> </dl> </div> <div class="section" id="qapidoc-1462"> <h4>Since<a class="headerlink" href="#qapidoc-1462" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1463"> <h4>If<a class="headerlink" href="#qapidoc-1463" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1468"> <h3><a class="toc-backref" href="#id194"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1468" title="Permalink to this headline">¶</a></h3> <p>Information about the TPM emulator type</p> <div class="section" id="qapidoc-1465"> <h4>Members<a class="headerlink" href="#qapidoc-1465" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Name of a unix socket chardev</dd> </dl> </div> <div class="section" id="qapidoc-1466"> <h4>Since<a class="headerlink" href="#qapidoc-1466" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> <div class="section" id="qapidoc-1467"> <h4>If<a class="headerlink" href="#qapidoc-1467" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1472"> <h3><a class="toc-backref" href="#id195"><code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptionsWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1472" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1469"> <h4>Members<a class="headerlink" href="#qapidoc-1469" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptions</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1470"> <h4>Since<a class="headerlink" href="#qapidoc-1470" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1471"> <h4>If<a class="headerlink" href="#qapidoc-1471" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1476"> <h3><a class="toc-backref" href="#id196"><code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptionsWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1476" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1473"> <h4>Members<a class="headerlink" href="#qapidoc-1473" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptions</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1474"> <h4>Since<a class="headerlink" href="#qapidoc-1474" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> <div class="section" id="qapidoc-1475"> <h4>If<a class="headerlink" href="#qapidoc-1475" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1480"> <h3><a class="toc-backref" href="#id197"><code class="docutils literal notranslate"><span class="pre">TpmTypeOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1480" title="Permalink to this headline">¶</a></h3> <p>A union referencing different TPM backend types’ configuration options</p> <div class="section" id="qapidoc-1477"> <h4>Members<a class="headerlink" href="#qapidoc-1477" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">TpmType</span></code></dt> <dd><ul class="first last simple"> <li>‘passthrough’ The configuration options for the TPM passthrough type</li> <li>‘emulator’ The configuration options for TPM emulator backend type</li> </ul> </dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">TPMPassthroughOptionsWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"passthrough"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">TPMEmulatorOptionsWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"emulator"</span></code></dl> </div> <div class="section" id="qapidoc-1478"> <h4>Since<a class="headerlink" href="#qapidoc-1478" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1479"> <h4>If<a class="headerlink" href="#qapidoc-1479" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1484"> <h3><a class="toc-backref" href="#id198"><code class="docutils literal notranslate"><span class="pre">TPMInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1484" title="Permalink to this headline">¶</a></h3> <p>Information about the TPM</p> <div class="section" id="qapidoc-1481"> <h4>Members<a class="headerlink" href="#qapidoc-1481" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The Id of the TPM</dd> <dt><code class="docutils literal notranslate"><span class="pre">model</span></code>: <code class="docutils literal notranslate"><span class="pre">TpmModel</span></code></dt> <dd>The TPM frontend model</dd> <dt><code class="docutils literal notranslate"><span class="pre">options</span></code>: <code class="docutils literal notranslate"><span class="pre">TpmTypeOptions</span></code></dt> <dd>The TPM (backend) type configuration options</dd> </dl> </div> <div class="section" id="qapidoc-1482"> <h4>Since<a class="headerlink" href="#qapidoc-1482" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1483"> <h4>If<a class="headerlink" href="#qapidoc-1483" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> <div class="section" id="qapidoc-1489"> <h3><a class="toc-backref" href="#id199"><code class="docutils literal notranslate"><span class="pre">query-tpm</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1489" title="Permalink to this headline">¶</a></h3> <p>Return information about the TPM device</p> <div class="section" id="qapidoc-1485"> <h4>Returns<a class="headerlink" href="#qapidoc-1485" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TPMInfo</span></code> on success</p> </div> <div class="section" id="qapidoc-1486"> <h4>Since<a class="headerlink" href="#qapidoc-1486" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-1487"> <h4>Example<a class="headerlink" href="#qapidoc-1487" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-tpm"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"model"</span><span class="p">:</span> <span class="s2">"tpm-tis"</span><span class="p">,</span> <span class="s2">"options"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"passthrough"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"cancel-path"</span><span class="p">:</span> <span class="s2">"/sys/class/misc/tpm0/device/cancel"</span><span class="p">,</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/dev/tpm0"</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"tpm0"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1488"> <h4>If<a class="headerlink" href="#qapidoc-1488" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TPM</span></code></p> </div> </div> </div> <div class="section" id="qapidoc-1490"> <h2><a class="toc-backref" href="#id200">Remote desktop</a><a class="headerlink" href="#qapidoc-1490" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1495"> <h3><a class="toc-backref" href="#id201"><code class="docutils literal notranslate"><span class="pre">set_password</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1495" title="Permalink to this headline">¶</a></h3> <p>Sets the password of a remote display session.</p> <div class="section" id="qapidoc-1491"> <h4>Arguments<a class="headerlink" href="#qapidoc-1491" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><ul class="first last simple"> <li>‘vnc’ to modify the VNC server password</li> <li>‘spice’ to modify the Spice server password</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">password</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the new password</dd> <dt><code class="docutils literal notranslate"><span class="pre">connected</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>how to handle existing clients when changing the password. If nothing is specified, defaults to ‘keep’ ‘fail’ to fail the command if clients are connected ‘disconnect’ to disconnect existing clients ‘keep’ to maintain existing clients</dd> </dl> </div> <div class="section" id="qapidoc-1492"> <h4>Returns<a class="headerlink" href="#qapidoc-1492" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li>If Spice is not enabled, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-1493"> <h4>Since<a class="headerlink" href="#qapidoc-1493" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1494"> <h4>Example<a class="headerlink" href="#qapidoc-1494" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"set_password"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"vnc"</span><span class="p">,</span> <span class="s2">"password"</span><span class="p">:</span> <span class="s2">"secret"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1501"> <h3><a class="toc-backref" href="#id202"><code class="docutils literal notranslate"><span class="pre">expire_password</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1501" title="Permalink to this headline">¶</a></h3> <p>Expire the password of a remote display server.</p> <div class="section" id="qapidoc-1496"> <h4>Arguments<a class="headerlink" href="#qapidoc-1496" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the remote display protocol ‘vnc’ or ‘spice’</dd> <dt><code class="docutils literal notranslate"><span class="pre">time</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><p class="first">when to expire the password.</p> <ul class="last simple"> <li>‘now’ to expire the password immediately</li> <li>‘never’ to cancel password expiration</li> <li>‘+INT’ where INT is the number of seconds from now (integer)</li> <li>‘INT’ where INT is the absolute time in seconds</li> </ul> </dd> </dl> </div> <div class="section" id="qapidoc-1497"> <h4>Returns<a class="headerlink" href="#qapidoc-1497" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">protocol</span></code> is ‘spice’ and Spice is not active, DeviceNotFound</li> </ul> </div> <div class="section" id="qapidoc-1498"> <h4>Since<a class="headerlink" href="#qapidoc-1498" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1499"> <h4>Notes<a class="headerlink" href="#qapidoc-1499" title="Permalink to this headline">¶</a></h4> <p>Time is relative to the server and currently there is no way to coordinate server time with client time. It is not recommended to use the absolute time version of the <code class="docutils literal notranslate"><span class="pre">time</span></code> parameter unless you’re sure you are on the same machine as the QEMU instance.</p> </div> <div class="section" id="qapidoc-1500"> <h4>Example<a class="headerlink" href="#qapidoc-1500" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"expire_password"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"vnc"</span><span class="p">,</span> <span class="s2">"time"</span><span class="p">:</span> <span class="s2">"+60"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1506"> <h3><a class="toc-backref" href="#id203"><code class="docutils literal notranslate"><span class="pre">screendump</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1506" title="Permalink to this headline">¶</a></h3> <p>Write a PPM of the VGA screen to a file.</p> <div class="section" id="qapidoc-1502"> <h4>Arguments<a class="headerlink" href="#qapidoc-1502" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path of a new PPM file to store the image</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the display device that should be dumped. If this parameter is missing, the primary display will be used. (Since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">head</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>head to use in case the device supports multiple heads. If this parameter is missing, head #0 will be used. Also note that the head can only be specified in conjunction with the device ID. (Since 2.12)</dd> </dl> </div> <div class="section" id="qapidoc-1503"> <h4>Returns<a class="headerlink" href="#qapidoc-1503" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-1504"> <h4>Since<a class="headerlink" href="#qapidoc-1504" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1505"> <h4>Example<a class="headerlink" href="#qapidoc-1505" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"screendump"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/image"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1507"> <h3><a class="toc-backref" href="#id204">Spice</a><a class="headerlink" href="#qapidoc-1507" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1511"> <h4><code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1511" title="Permalink to this headline">¶</a></h4> <p>The basic information for SPICE network connection</p> <div class="section" id="qapidoc-1508"> <h5>Members<a class="headerlink" href="#qapidoc-1508" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>IP address</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>port number</dd> <dt><code class="docutils literal notranslate"><span class="pre">family</span></code>: <code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code></dt> <dd>address family</dd> </dl> </div> <div class="section" id="qapidoc-1509"> <h5>Since<a class="headerlink" href="#qapidoc-1509" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> <div class="section" id="qapidoc-1510"> <h5>If<a class="headerlink" href="#qapidoc-1510" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1515"> <h4><code class="docutils literal notranslate"><span class="pre">SpiceServerInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1515" title="Permalink to this headline">¶</a></h4> <p>Information about a SPICE server</p> <div class="section" id="qapidoc-1512"> <h5>Members<a class="headerlink" href="#qapidoc-1512" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>authentication method</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dl> </div> <div class="section" id="qapidoc-1513"> <h5>Since<a class="headerlink" href="#qapidoc-1513" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> <div class="section" id="qapidoc-1514"> <h5>If<a class="headerlink" href="#qapidoc-1514" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1519"> <h4><code class="docutils literal notranslate"><span class="pre">SpiceChannel</span></code> (Object)<a class="headerlink" href="#qapidoc-1519" title="Permalink to this headline">¶</a></h4> <p>Information about a SPICE client channel.</p> <div class="section" id="qapidoc-1516"> <h5>Members<a class="headerlink" href="#qapidoc-1516" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">connection-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SPICE connection id number. All channels with the same id belong to the same SPICE session.</dd> <dt><code class="docutils literal notranslate"><span class="pre">channel-type</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SPICE channel type number. “1” is the main control channel, filter for this one if you want to track spice sessions only</dd> <dt><code class="docutils literal notranslate"><span class="pre">channel-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SPICE channel ID number. Usually “0”, might be different when multiple channels of the same type exist, such as multiple display channels in a multihead setup</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the channel is encrypted, false otherwise.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dl> </div> <div class="section" id="qapidoc-1517"> <h5>Since<a class="headerlink" href="#qapidoc-1517" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1518"> <h5>If<a class="headerlink" href="#qapidoc-1518" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1524"> <h4><code class="docutils literal notranslate"><span class="pre">SpiceQueryMouseMode</span></code> (Enum)<a class="headerlink" href="#qapidoc-1524" title="Permalink to this headline">¶</a></h4> <p>An enumeration of Spice mouse states.</p> <div class="section" id="qapidoc-1520"> <h5>Values<a class="headerlink" href="#qapidoc-1520" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code></dt> <dd>Mouse cursor position is determined by the client.</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code></dt> <dd>Mouse cursor position is determined by the server.</dd> <dt><code class="docutils literal notranslate"><span class="pre">unknown</span></code></dt> <dd>No information is available about mouse mode used by the spice server.</dd> </dl> </div> <div class="section" id="qapidoc-1521"> <h5>Note<a class="headerlink" href="#qapidoc-1521" title="Permalink to this headline">¶</a></h5> <p>spice/enums.h has a SpiceMouseMode already, hence the name.</p> </div> <div class="section" id="qapidoc-1522"> <h5>Since<a class="headerlink" href="#qapidoc-1522" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-1523"> <h5>If<a class="headerlink" href="#qapidoc-1523" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1528"> <h4><code class="docutils literal notranslate"><span class="pre">SpiceInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1528" title="Permalink to this headline">¶</a></h4> <p>Information about the SPICE session.</p> <div class="section" id="qapidoc-1525"> <h5>Members<a class="headerlink" href="#qapidoc-1525" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the SPICE server is enabled, false otherwise</dd> <dt><code class="docutils literal notranslate"><span class="pre">migrated</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the last guest migration completed and spice migration had completed as well. false otherwise. (since 1.4)</dd> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The hostname the SPICE server is bound to. This depends on the name resolution on the host and may be an IP address.</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The SPICE server’s port number.</dd> <dt><code class="docutils literal notranslate"><span class="pre">compiled-version</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>SPICE server version.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-port</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The SPICE server’s TLS port number.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd><p class="first">the current authentication type used by the server</p> <ul class="last simple"> <li>‘none’ if no authentication is being used</li> <li>‘spice’ uses SASL or direct TLS authentication, depending on command line options</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">mouse-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceQueryMouseMode</span></code></dt> <dd>The mode in which the mouse cursor is displayed currently. Can be determined by the client or the server, or unknown if spice server doesn’t provide this information. (since: 1.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">channels</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SpiceChannel</span></code> (optional)</dt> <dd>a list of <code class="docutils literal notranslate"><span class="pre">SpiceChannel</span></code> for each active spice channel</dd> </dl> </div> <div class="section" id="qapidoc-1526"> <h5>Since<a class="headerlink" href="#qapidoc-1526" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1527"> <h5>If<a class="headerlink" href="#qapidoc-1527" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1533"> <h4><code class="docutils literal notranslate"><span class="pre">query-spice</span></code> (Command)<a class="headerlink" href="#qapidoc-1533" title="Permalink to this headline">¶</a></h4> <p>Returns information about the current SPICE server</p> <div class="section" id="qapidoc-1529"> <h5>Returns<a class="headerlink" href="#qapidoc-1529" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">SpiceInfo</span></code></p> </div> <div class="section" id="qapidoc-1530"> <h5>Since<a class="headerlink" href="#qapidoc-1530" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1531"> <h5>Example<a class="headerlink" href="#qapidoc-1531" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-spice"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"auth"</span><span class="p">:</span> <span class="s2">"spice"</span><span class="p">,</span> <span class="s2">"port"</span><span class="p">:</span> <span class="mi">5920</span><span class="p">,</span> <span class="s2">"tls-port"</span><span class="p">:</span> <span class="mi">5921</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"0.0.0.0"</span><span class="p">,</span> <span class="s2">"channels"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"port"</span><span class="p">:</span> <span class="s2">"54924"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"channel-type"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"connection-id"</span><span class="p">:</span> <span class="mi">1804289383</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"channel-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"tls"</span><span class="p">:</span> <span class="n">true</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"port"</span><span class="p">:</span> <span class="s2">"36710"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"channel-type"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">"connection-id"</span><span class="p">:</span> <span class="mi">1804289383</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"channel-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"tls"</span><span class="p">:</span> <span class="n">false</span> <span class="p">},</span> <span class="p">[</span> <span class="o">...</span> <span class="n">more</span> <span class="n">channels</span> <span class="n">follow</span> <span class="o">...</span> <span class="p">]</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1532"> <h5>If<a class="headerlink" href="#qapidoc-1532" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1538"> <h4><code class="docutils literal notranslate"><span class="pre">SPICE_CONNECTED</span></code> (Event)<a class="headerlink" href="#qapidoc-1538" title="Permalink to this headline">¶</a></h4> <p>Emitted when a SPICE client establishes a connection</p> <div class="section" id="qapidoc-1534"> <h5>Arguments<a class="headerlink" href="#qapidoc-1534" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1535"> <h5>Since<a class="headerlink" href="#qapidoc-1535" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1536"> <h5>Example<a class="headerlink" href="#qapidoc-1536" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1290688046</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">388707</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SPICE_CONNECTED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"port"</span><span class="p">:</span> <span class="s2">"5920"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"port"</span><span class="p">:</span> <span class="s2">"52873"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">}</span> <span class="p">}}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1537"> <h5>If<a class="headerlink" href="#qapidoc-1537" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1543"> <h4><code class="docutils literal notranslate"><span class="pre">SPICE_INITIALIZED</span></code> (Event)<a class="headerlink" href="#qapidoc-1543" title="Permalink to this headline">¶</a></h4> <p>Emitted after initial handshake and authentication takes place (if any) and the SPICE channel is up and running</p> <div class="section" id="qapidoc-1539"> <h5>Arguments<a class="headerlink" href="#qapidoc-1539" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceServerInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceChannel</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1540"> <h5>Since<a class="headerlink" href="#qapidoc-1540" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1541"> <h5>Example<a class="headerlink" href="#qapidoc-1541" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1290688046</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">417172</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SPICE_INITIALIZED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"auth"</span><span class="p">:</span> <span class="s2">"spice"</span><span class="p">,</span> <span class="s2">"port"</span><span class="p">:</span> <span class="s2">"5921"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"port"</span><span class="p">:</span> <span class="s2">"49004"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"channel-type"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">"connection-id"</span><span class="p">:</span> <span class="mi">1804289383</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"channel-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"tls"</span><span class="p">:</span> <span class="n">true</span><span class="p">}</span> <span class="p">}}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1542"> <h5>If<a class="headerlink" href="#qapidoc-1542" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1548"> <h4><code class="docutils literal notranslate"><span class="pre">SPICE_DISCONNECTED</span></code> (Event)<a class="headerlink" href="#qapidoc-1548" title="Permalink to this headline">¶</a></h4> <p>Emitted when the SPICE connection is closed</p> <div class="section" id="qapidoc-1544"> <h5>Arguments<a class="headerlink" href="#qapidoc-1544" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">SpiceBasicInfo</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1545"> <h5>Since<a class="headerlink" href="#qapidoc-1545" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1546"> <h5>Example<a class="headerlink" href="#qapidoc-1546" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1290688046</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">388707</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SPICE_DISCONNECTED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"port"</span><span class="p">:</span> <span class="s2">"5920"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"port"</span><span class="p">:</span> <span class="s2">"52873"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">}</span> <span class="p">}}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1547"> <h5>If<a class="headerlink" href="#qapidoc-1547" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> <div class="section" id="qapidoc-1552"> <h4><code class="docutils literal notranslate"><span class="pre">SPICE_MIGRATE_COMPLETED</span></code> (Event)<a class="headerlink" href="#qapidoc-1552" title="Permalink to this headline">¶</a></h4> <p>Emitted when SPICE migration has completed</p> <div class="section" id="qapidoc-1549"> <h5>Since<a class="headerlink" href="#qapidoc-1549" title="Permalink to this headline">¶</a></h5> <p>1.3</p> </div> <div class="section" id="qapidoc-1550"> <h5>Example<a class="headerlink" href="#qapidoc-1550" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1290688046</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">417172</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"SPICE_MIGRATE_COMPLETED"</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1551"> <h5>If<a class="headerlink" href="#qapidoc-1551" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code></p> </div> </div> </div> <div class="section" id="qapidoc-1553"> <h3><a class="toc-backref" href="#id205">VNC</a><a class="headerlink" href="#qapidoc-1553" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1557"> <h4><code class="docutils literal notranslate"><span class="pre">VncBasicInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1557" title="Permalink to this headline">¶</a></h4> <p>The basic information for vnc network connection</p> <div class="section" id="qapidoc-1554"> <h5>Members<a class="headerlink" href="#qapidoc-1554" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>IP address</dd> <dt><code class="docutils literal notranslate"><span class="pre">service</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The service name of the vnc port. This may depend on the host system’s service database so symbolic names should not be relied on.</dd> <dt><code class="docutils literal notranslate"><span class="pre">family</span></code>: <code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code></dt> <dd>address family</dd> <dt><code class="docutils literal notranslate"><span class="pre">websocket</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true in case the socket is a websocket (since 2.3).</dd> </dl> </div> <div class="section" id="qapidoc-1555"> <h5>Since<a class="headerlink" href="#qapidoc-1555" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> <div class="section" id="qapidoc-1556"> <h5>If<a class="headerlink" href="#qapidoc-1556" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1561"> <h4><code class="docutils literal notranslate"><span class="pre">VncServerInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1561" title="Permalink to this headline">¶</a></h4> <p>The network connection information for server</p> <div class="section" id="qapidoc-1558"> <h5>Members<a class="headerlink" href="#qapidoc-1558" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>authentication method used for the plain (non-websocket) VNC server</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">VncBasicInfo</span></code></dl> </div> <div class="section" id="qapidoc-1559"> <h5>Since<a class="headerlink" href="#qapidoc-1559" title="Permalink to this headline">¶</a></h5> <p>2.1</p> </div> <div class="section" id="qapidoc-1560"> <h5>If<a class="headerlink" href="#qapidoc-1560" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1565"> <h4><code class="docutils literal notranslate"><span class="pre">VncClientInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1565" title="Permalink to this headline">¶</a></h4> <p>Information about a connected VNC client.</p> <div class="section" id="qapidoc-1562"> <h5>Members<a class="headerlink" href="#qapidoc-1562" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">x509_dname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>If x509 authentication is in use, the Distinguished Name of the client.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sasl_username</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>If SASL authentication is in use, the SASL username used for authentication.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">VncBasicInfo</span></code></dl> </div> <div class="section" id="qapidoc-1563"> <h5>Since<a class="headerlink" href="#qapidoc-1563" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1564"> <h5>If<a class="headerlink" href="#qapidoc-1564" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1569"> <h4><code class="docutils literal notranslate"><span class="pre">VncInfo</span></code> (Object)<a class="headerlink" href="#qapidoc-1569" title="Permalink to this headline">¶</a></h4> <p>Information about the VNC session.</p> <div class="section" id="qapidoc-1566"> <h5>Members<a class="headerlink" href="#qapidoc-1566" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the VNC server is enabled, false otherwise</dd> <dt><code class="docutils literal notranslate"><span class="pre">host</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The hostname the VNC server is bound to. This depends on the name resolution on the host and may be an IP address.</dd> <dt><code class="docutils literal notranslate"><span class="pre">family</span></code>: <code class="docutils literal notranslate"><span class="pre">NetworkAddressFamily</span></code> (optional)</dt> <dd><ul class="first last simple"> <li>‘ipv6’ if the host is listening for IPv6 connections</li> <li>‘ipv4’ if the host is listening for IPv4 connections</li> <li>‘unix’ if the host is listening on a unix domain socket</li> <li>‘unknown’ otherwise</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">service</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The service name of the server’s port. This may depends on the host system’s service database so symbolic names should not be relied on.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd><p class="first">the current authentication type used by the server</p> <ul class="last simple"> <li>‘none’ if no authentication is being used</li> <li>‘vnc’ if VNC authentication is being used</li> <li>‘vencrypt+plain’ if VEncrypt is used with plain text authentication</li> <li>‘vencrypt+tls+none’ if VEncrypt is used with TLS and no authentication</li> <li>‘vencrypt+tls+vnc’ if VEncrypt is used with TLS and VNC authentication</li> <li>‘vencrypt+tls+plain’ if VEncrypt is used with TLS and plain text auth</li> <li>‘vencrypt+x509+none’ if VEncrypt is used with x509 and no auth</li> <li>‘vencrypt+x509+vnc’ if VEncrypt is used with x509 and VNC auth</li> <li>‘vencrypt+x509+plain’ if VEncrypt is used with x509 and plain text auth</li> <li>‘vencrypt+tls+sasl’ if VEncrypt is used with TLS and SASL auth</li> <li>‘vencrypt+x509+sasl’ if VEncrypt is used with x509 and SASL auth</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">clients</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">VncClientInfo</span></code> (optional)</dt> <dd>a list of <code class="docutils literal notranslate"><span class="pre">VncClientInfo</span></code> of all currently connected clients</dd> </dl> </div> <div class="section" id="qapidoc-1567"> <h5>Since<a class="headerlink" href="#qapidoc-1567" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1568"> <h5>If<a class="headerlink" href="#qapidoc-1568" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1573"> <h4><code class="docutils literal notranslate"><span class="pre">VncPrimaryAuth</span></code> (Enum)<a class="headerlink" href="#qapidoc-1573" title="Permalink to this headline">¶</a></h4> <p>vnc primary authentication method.</p> <div class="section" id="qapidoc-1570"> <h5>Values<a class="headerlink" href="#qapidoc-1570" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vnc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ra2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ra2ne</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tight</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ultra</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">vencrypt</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sasl</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1571"> <h5>Since<a class="headerlink" href="#qapidoc-1571" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-1572"> <h5>If<a class="headerlink" href="#qapidoc-1572" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1577"> <h4><code class="docutils literal notranslate"><span class="pre">VncVencryptSubAuth</span></code> (Enum)<a class="headerlink" href="#qapidoc-1577" title="Permalink to this headline">¶</a></h4> <p>vnc sub authentication method with vencrypt.</p> <div class="section" id="qapidoc-1574"> <h5>Values<a class="headerlink" href="#qapidoc-1574" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">plain</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x509-none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-vnc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x509-vnc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-plain</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x509-plain</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-sasl</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x509-sasl</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1575"> <h5>Since<a class="headerlink" href="#qapidoc-1575" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-1576"> <h5>If<a class="headerlink" href="#qapidoc-1576" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1581"> <h4><code class="docutils literal notranslate"><span class="pre">VncServerInfo2</span></code> (Object)<a class="headerlink" href="#qapidoc-1581" title="Permalink to this headline">¶</a></h4> <p>The network connection information for server</p> <div class="section" id="qapidoc-1578"> <h5>Members<a class="headerlink" href="#qapidoc-1578" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">VncPrimaryAuth</span></code></dt> <dd>The current authentication type used by the servers</dd> <dt><code class="docutils literal notranslate"><span class="pre">vencrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">VncVencryptSubAuth</span></code> (optional)</dt> <dd>The vencrypt sub authentication type used by the servers, only specified in case auth == vencrypt.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">VncBasicInfo</span></code></dl> </div> <div class="section" id="qapidoc-1579"> <h5>Since<a class="headerlink" href="#qapidoc-1579" title="Permalink to this headline">¶</a></h5> <p>2.9</p> </div> <div class="section" id="qapidoc-1580"> <h5>If<a class="headerlink" href="#qapidoc-1580" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1585"> <h4><code class="docutils literal notranslate"><span class="pre">VncInfo2</span></code> (Object)<a class="headerlink" href="#qapidoc-1585" title="Permalink to this headline">¶</a></h4> <p>Information about a vnc server</p> <div class="section" id="qapidoc-1582"> <h5>Members<a class="headerlink" href="#qapidoc-1582" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>vnc server name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">VncServerInfo2</span></code></dt> <dd>A list of <code class="docutils literal notranslate"><span class="pre">VncBasincInfo</span></code> describing all listening sockets. The list can be empty (in case the vnc server is disabled). It also may have multiple entries: normal + websocket, possibly also ipv4 + ipv6 in the future.</dd> <dt><code class="docutils literal notranslate"><span class="pre">clients</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">VncClientInfo</span></code></dt> <dd>A list of <code class="docutils literal notranslate"><span class="pre">VncClientInfo</span></code> of all currently connected clients. The list can be empty, for obvious reasons.</dd> <dt><code class="docutils literal notranslate"><span class="pre">auth</span></code>: <code class="docutils literal notranslate"><span class="pre">VncPrimaryAuth</span></code></dt> <dd>The current authentication type used by the non-websockets servers</dd> <dt><code class="docutils literal notranslate"><span class="pre">vencrypt</span></code>: <code class="docutils literal notranslate"><span class="pre">VncVencryptSubAuth</span></code> (optional)</dt> <dd>The vencrypt authentication type used by the servers, only specified in case auth == vencrypt.</dd> <dt><code class="docutils literal notranslate"><span class="pre">display</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The display device the vnc server is linked to.</dd> </dl> </div> <div class="section" id="qapidoc-1583"> <h5>Since<a class="headerlink" href="#qapidoc-1583" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-1584"> <h5>If<a class="headerlink" href="#qapidoc-1584" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1590"> <h4><code class="docutils literal notranslate"><span class="pre">query-vnc</span></code> (Command)<a class="headerlink" href="#qapidoc-1590" title="Permalink to this headline">¶</a></h4> <p>Returns information about the current VNC server</p> <div class="section" id="qapidoc-1586"> <h5>Returns<a class="headerlink" href="#qapidoc-1586" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">VncInfo</span></code></p> </div> <div class="section" id="qapidoc-1587"> <h5>Since<a class="headerlink" href="#qapidoc-1587" title="Permalink to this headline">¶</a></h5> <p>0.14</p> </div> <div class="section" id="qapidoc-1588"> <h5>Example<a class="headerlink" href="#qapidoc-1588" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-vnc"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enabled"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span><span class="s2">"0.0.0.0"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span><span class="s2">"50402"</span><span class="p">,</span> <span class="s2">"auth"</span><span class="p">:</span><span class="s2">"vnc"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span><span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"clients"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"host"</span><span class="p">:</span><span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span><span class="s2">"50401"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span><span class="s2">"ipv4"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1589"> <h5>If<a class="headerlink" href="#qapidoc-1589" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1594"> <h4><code class="docutils literal notranslate"><span class="pre">query-vnc-servers</span></code> (Command)<a class="headerlink" href="#qapidoc-1594" title="Permalink to this headline">¶</a></h4> <p>Returns a list of vnc servers. The list can be empty.</p> <div class="section" id="qapidoc-1591"> <h5>Returns<a class="headerlink" href="#qapidoc-1591" title="Permalink to this headline">¶</a></h5> <p>a list of <code class="docutils literal notranslate"><span class="pre">VncInfo2</span></code></p> </div> <div class="section" id="qapidoc-1592"> <h5>Since<a class="headerlink" href="#qapidoc-1592" title="Permalink to this headline">¶</a></h5> <p>2.3</p> </div> <div class="section" id="qapidoc-1593"> <h5>If<a class="headerlink" href="#qapidoc-1593" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1599"> <h4><code class="docutils literal notranslate"><span class="pre">change-vnc-password</span></code> (Command)<a class="headerlink" href="#qapidoc-1599" title="Permalink to this headline">¶</a></h4> <p>Change the VNC server password.</p> <div class="section" id="qapidoc-1595"> <h5>Arguments<a class="headerlink" href="#qapidoc-1595" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">password</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the new password to use with VNC authentication</dd> </dl> </div> <div class="section" id="qapidoc-1596"> <h5>Since<a class="headerlink" href="#qapidoc-1596" title="Permalink to this headline">¶</a></h5> <p>1.1</p> </div> <div class="section" id="qapidoc-1597"> <h5>Notes<a class="headerlink" href="#qapidoc-1597" title="Permalink to this headline">¶</a></h5> <p>An empty password in this command will set the password to the empty string. Existing clients are unaffected by executing this command.</p> </div> <div class="section" id="qapidoc-1598"> <h5>If<a class="headerlink" href="#qapidoc-1598" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1605"> <h4><code class="docutils literal notranslate"><span class="pre">VNC_CONNECTED</span></code> (Event)<a class="headerlink" href="#qapidoc-1605" title="Permalink to this headline">¶</a></h4> <p>Emitted when a VNC client establishes a connection</p> <div class="section" id="qapidoc-1600"> <h5>Arguments<a class="headerlink" href="#qapidoc-1600" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">VncServerInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">VncBasicInfo</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1601"> <h5>Note<a class="headerlink" href="#qapidoc-1601" title="Permalink to this headline">¶</a></h5> <p>This event is emitted before any authentication takes place, thus the authentication ID is not provided</p> </div> <div class="section" id="qapidoc-1602"> <h5>Since<a class="headerlink" href="#qapidoc-1602" title="Permalink to this headline">¶</a></h5> <p>0.13</p> </div> <div class="section" id="qapidoc-1603"> <h5>Example<a class="headerlink" href="#qapidoc-1603" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"VNC_CONNECTED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"auth"</span><span class="p">:</span> <span class="s2">"sasl"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"5901"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"0.0.0.0"</span> <span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"58425"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1262976601</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">975795</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1604"> <h5>If<a class="headerlink" href="#qapidoc-1604" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1610"> <h4><code class="docutils literal notranslate"><span class="pre">VNC_INITIALIZED</span></code> (Event)<a class="headerlink" href="#qapidoc-1610" title="Permalink to this headline">¶</a></h4> <p>Emitted after authentication takes place (if any) and the VNC session is made active</p> <div class="section" id="qapidoc-1606"> <h5>Arguments<a class="headerlink" href="#qapidoc-1606" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">VncServerInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">VncClientInfo</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1607"> <h5>Since<a class="headerlink" href="#qapidoc-1607" title="Permalink to this headline">¶</a></h5> <p>0.13</p> </div> <div class="section" id="qapidoc-1608"> <h5>Example<a class="headerlink" href="#qapidoc-1608" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"VNC_INITIALIZED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"auth"</span><span class="p">:</span> <span class="s2">"sasl"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"5901"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"0.0.0.0"</span><span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"46089"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"sasl_username"</span><span class="p">:</span> <span class="s2">"luiz"</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1263475302</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">150772</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1609"> <h5>If<a class="headerlink" href="#qapidoc-1609" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> <div class="section" id="qapidoc-1615"> <h4><code class="docutils literal notranslate"><span class="pre">VNC_DISCONNECTED</span></code> (Event)<a class="headerlink" href="#qapidoc-1615" title="Permalink to this headline">¶</a></h4> <p>Emitted when the connection is closed</p> <div class="section" id="qapidoc-1611"> <h5>Arguments<a class="headerlink" href="#qapidoc-1611" title="Permalink to this headline">¶</a></h5> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">VncServerInfo</span></code></dt> <dd>server information</dd> <dt><code class="docutils literal notranslate"><span class="pre">client</span></code>: <code class="docutils literal notranslate"><span class="pre">VncClientInfo</span></code></dt> <dd>client information</dd> </dl> </div> <div class="section" id="qapidoc-1612"> <h5>Since<a class="headerlink" href="#qapidoc-1612" title="Permalink to this headline">¶</a></h5> <p>0.13</p> </div> <div class="section" id="qapidoc-1613"> <h5>Example<a class="headerlink" href="#qapidoc-1613" title="Permalink to this headline">¶</a></h5> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"VNC_DISCONNECTED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"server"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"auth"</span><span class="p">:</span> <span class="s2">"sasl"</span><span class="p">,</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"5901"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"0.0.0.0"</span> <span class="p">},</span> <span class="s2">"client"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"family"</span><span class="p">:</span> <span class="s2">"ipv4"</span><span class="p">,</span> <span class="s2">"service"</span><span class="p">:</span> <span class="s2">"58425"</span><span class="p">,</span> <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"127.0.0.1"</span><span class="p">,</span> <span class="s2">"sasl_username"</span><span class="p">:</span> <span class="s2">"luiz"</span> <span class="p">}</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1262976601</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">975795</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1614"> <h5>If<a class="headerlink" href="#qapidoc-1614" title="Permalink to this headline">¶</a></h5> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_VNC</span></code></p> </div> </div> </div> </div> <div class="section" id="qapidoc-1616"> <h2><a class="toc-backref" href="#id206">Input</a><a class="headerlink" href="#qapidoc-1616" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1619"> <h3><a class="toc-backref" href="#id207"><code class="docutils literal notranslate"><span class="pre">MouseInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1619" title="Permalink to this headline">¶</a></h3> <p>Information about a mouse device.</p> <div class="section" id="qapidoc-1617"> <h4>Members<a class="headerlink" href="#qapidoc-1617" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the mouse device</dd> <dt><code class="docutils literal notranslate"><span class="pre">index</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the index of the mouse device</dd> <dt><code class="docutils literal notranslate"><span class="pre">current</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if this device is currently receiving mouse events</dd> <dt><code class="docutils literal notranslate"><span class="pre">absolute</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if this device supports absolute coordinates as input</dd> </dl> </div> <div class="section" id="qapidoc-1618"> <h4>Since<a class="headerlink" href="#qapidoc-1618" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-1623"> <h3><a class="toc-backref" href="#id208"><code class="docutils literal notranslate"><span class="pre">query-mice</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1623" title="Permalink to this headline">¶</a></h3> <p>Returns information about each active mouse device</p> <div class="section" id="qapidoc-1620"> <h4>Returns<a class="headerlink" href="#qapidoc-1620" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">MouseInfo</span></code> for each device</p> </div> <div class="section" id="qapidoc-1621"> <h4>Since<a class="headerlink" href="#qapidoc-1621" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1622"> <h4>Example<a class="headerlink" href="#qapidoc-1622" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-mice"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"QEMU Microsoft Mouse"</span><span class="p">,</span> <span class="s2">"index"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"current"</span><span class="p">:</span><span class="n">false</span><span class="p">,</span> <span class="s2">"absolute"</span><span class="p">:</span><span class="n">false</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"QEMU PS/2 Mouse"</span><span class="p">,</span> <span class="s2">"index"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"current"</span><span class="p">:</span><span class="n">true</span><span class="p">,</span> <span class="s2">"absolute"</span><span class="p">:</span><span class="n">true</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1627"> <h3><a class="toc-backref" href="#id209"><code class="docutils literal notranslate"><span class="pre">QKeyCode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1627" title="Permalink to this headline">¶</a></h3> <p>An enumeration of key name.</p> <p>This is used by the <code class="docutils literal notranslate"><span class="pre">send-key</span></code> command.</p> <div class="section" id="qapidoc-1624"> <h4>Values<a class="headerlink" href="#qapidoc-1624" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unmapped</span></code></dt> <dd>since 2.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt> <dd>since 2.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">ro</span></code></dt> <dd>since 2.4</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_comma</span></code></dt> <dd>since 2.4</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_equals</span></code></dt> <dd>since 2.6</dd> <dt><code class="docutils literal notranslate"><span class="pre">power</span></code></dt> <dd>since 2.6</dd> <dt><code class="docutils literal notranslate"><span class="pre">hiragana</span></code></dt> <dd>since 2.9</dd> <dt><code class="docutils literal notranslate"><span class="pre">henkan</span></code></dt> <dd>since 2.9</dd> <dt><code class="docutils literal notranslate"><span class="pre">yen</span></code></dt> <dd>since 2.9</dd> <dt><code class="docutils literal notranslate"><span class="pre">sleep</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">wake</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">audionext</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">audioprev</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">audiostop</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">audioplay</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">audiomute</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">volumeup</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">volumedown</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">mediaselect</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">mail</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">calculator</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">computer</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">ac_home</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">ac_back</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">ac_forward</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">ac_refresh</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">ac_bookmarks</span></code></dt> <dd>since 2.10</dd> <dt><code class="docutils literal notranslate"><span class="pre">muhenkan</span></code></dt> <dd>since 2.12</dd> <dt><code class="docutils literal notranslate"><span class="pre">katakanahiragana</span></code></dt> <dd>since 2.12</dd> <dt><code class="docutils literal notranslate"><span class="pre">lang1</span></code></dt> <dd>since 6.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">lang2</span></code></dt> <dd>since 6.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">shift</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">shift_r</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">alt</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">alt_r</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ctrl</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ctrl_r</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">menu</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">esc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">1</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">3</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">4</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">5</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">6</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">7</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">8</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">9</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">0</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">minus</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">equal</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">backspace</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tab</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">q</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">w</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">e</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">r</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">t</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">y</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">u</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">i</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">o</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">p</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">bracket_left</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">bracket_right</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ret</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">a</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">s</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">d</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">g</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">h</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">j</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">k</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">l</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">semicolon</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">apostrophe</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">grave_accent</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">backslash</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">z</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">c</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">v</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">b</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">n</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">m</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">comma</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">dot</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">slash</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">asterisk</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">spc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">caps_lock</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f1</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f3</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f4</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f5</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f6</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f7</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f8</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f9</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f10</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">num_lock</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">scroll_lock</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_divide</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_multiply</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_subtract</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_add</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_enter</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_decimal</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sysrq</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_0</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_1</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_3</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_4</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_5</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_6</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_7</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_8</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">kp_9</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">less</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f11</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">f12</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">print</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">home</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pgup</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pgdn</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">end</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">left</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">up</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">down</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">right</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">insert</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">delete</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">stop</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">again</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">props</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">undo</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">front</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">copy</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">open</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">paste</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">find</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cut</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">lf</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">help</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">meta_l</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">meta_r</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">compose</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1625"> ‘sysrq’ was mistakenly added to hack around the fact that the ps2 driver was not generating correct scancodes sequences when ‘alt+print’ was pressed. This flaw is now fixed and the ‘sysrq’ key serves no further purpose. Any further use of ‘sysrq’ will be transparently changed to ‘print’, so they are effectively synonyms.</div> <div class="section" id="qapidoc-1626"> <h4>Since<a class="headerlink" href="#qapidoc-1626" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1630"> <h3><a class="toc-backref" href="#id210"><code class="docutils literal notranslate"><span class="pre">KeyValueKind</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1630" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1628"> <h4>Values<a class="headerlink" href="#qapidoc-1628" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">qcode</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1629"> <h4>Since<a class="headerlink" href="#qapidoc-1629" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1633"> <h3><a class="toc-backref" href="#id211"><code class="docutils literal notranslate"><span class="pre">IntWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1633" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1631"> <h4>Members<a class="headerlink" href="#qapidoc-1631" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1632"> <h4>Since<a class="headerlink" href="#qapidoc-1632" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1636"> <h3><a class="toc-backref" href="#id212"><code class="docutils literal notranslate"><span class="pre">QKeyCodeWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1636" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1634"> <h4>Members<a class="headerlink" href="#qapidoc-1634" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">QKeyCode</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1635"> <h4>Since<a class="headerlink" href="#qapidoc-1635" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1639"> <h3><a class="toc-backref" href="#id213"><code class="docutils literal notranslate"><span class="pre">KeyValue</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1639" title="Permalink to this headline">¶</a></h3> <p>Represents a keyboard key.</p> <div class="section" id="qapidoc-1637"> <h4>Members<a class="headerlink" href="#qapidoc-1637" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">KeyValueKind</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">IntWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"number"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">QKeyCodeWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"qcode"</span></code></dl> </div> <div class="section" id="qapidoc-1638"> <h4>Since<a class="headerlink" href="#qapidoc-1638" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-1644"> <h3><a class="toc-backref" href="#id214"><code class="docutils literal notranslate"><span class="pre">send-key</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1644" title="Permalink to this headline">¶</a></h3> <p>Send keys to guest.</p> <div class="section" id="qapidoc-1640"> <h4>Arguments<a class="headerlink" href="#qapidoc-1640" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">keys</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">KeyValue</span></code></dt> <dd>An array of <code class="docutils literal notranslate"><span class="pre">KeyValue</span></code> elements. All <code class="docutils literal notranslate"><span class="pre">KeyValues</span></code> in this array are simultaneously sent to the guest. A <code class="docutils literal notranslate"><span class="pre">KeyValue</span></code>.number value is sent directly to the guest, while <code class="docutils literal notranslate"><span class="pre">KeyValue</span></code>.qcode must be a valid <code class="docutils literal notranslate"><span class="pre">QKeyCode</span></code> value</dd> <dt><code class="docutils literal notranslate"><span class="pre">hold-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>time to delay key up events, milliseconds. Defaults to 100</dd> </dl> </div> <div class="section" id="qapidoc-1641"> <h4>Returns<a class="headerlink" href="#qapidoc-1641" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li>If key is unknown or redundant, InvalidParameter</li> </ul> </div> <div class="section" id="qapidoc-1642"> <h4>Since<a class="headerlink" href="#qapidoc-1642" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> <div class="section" id="qapidoc-1643"> <h4>Example<a class="headerlink" href="#qapidoc-1643" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"send-key"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"keys"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"ctrl"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"alt"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"delete"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1647"> <h3><a class="toc-backref" href="#id215"><code class="docutils literal notranslate"><span class="pre">InputButton</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1647" title="Permalink to this headline">¶</a></h3> <p>Button of a pointer input device (mouse, tablet).</p> <div class="section" id="qapidoc-1645"> <h4>Values<a class="headerlink" href="#qapidoc-1645" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">side</span></code></dt> <dd>front side button of a 5-button mouse (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">extra</span></code></dt> <dd>rear side button of a 5-button mouse (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">left</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">middle</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">right</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">wheel-up</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">wheel-down</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1646"> <h4>Since<a class="headerlink" href="#qapidoc-1646" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1650"> <h3><a class="toc-backref" href="#id216"><code class="docutils literal notranslate"><span class="pre">InputAxis</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1650" title="Permalink to this headline">¶</a></h3> <p>Position axis of a pointer input device (mouse, tablet).</p> <div class="section" id="qapidoc-1648"> <h4>Values<a class="headerlink" href="#qapidoc-1648" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">x</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">y</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1649"> <h4>Since<a class="headerlink" href="#qapidoc-1649" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1653"> <h3><a class="toc-backref" href="#id217"><code class="docutils literal notranslate"><span class="pre">InputKeyEvent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1653" title="Permalink to this headline">¶</a></h3> <p>Keyboard input event.</p> <div class="section" id="qapidoc-1651"> <h4>Members<a class="headerlink" href="#qapidoc-1651" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key</span></code>: <code class="docutils literal notranslate"><span class="pre">KeyValue</span></code></dt> <dd>Which key this event is for.</dd> <dt><code class="docutils literal notranslate"><span class="pre">down</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>True for key-down and false for key-up events.</dd> </dl> </div> <div class="section" id="qapidoc-1652"> <h4>Since<a class="headerlink" href="#qapidoc-1652" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1656"> <h3><a class="toc-backref" href="#id218"><code class="docutils literal notranslate"><span class="pre">InputBtnEvent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1656" title="Permalink to this headline">¶</a></h3> <p>Pointer button input event.</p> <div class="section" id="qapidoc-1654"> <h4>Members<a class="headerlink" href="#qapidoc-1654" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">button</span></code>: <code class="docutils literal notranslate"><span class="pre">InputButton</span></code></dt> <dd>Which button this event is for.</dd> <dt><code class="docutils literal notranslate"><span class="pre">down</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>True for key-down and false for key-up events.</dd> </dl> </div> <div class="section" id="qapidoc-1655"> <h4>Since<a class="headerlink" href="#qapidoc-1655" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1659"> <h3><a class="toc-backref" href="#id219"><code class="docutils literal notranslate"><span class="pre">InputMoveEvent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1659" title="Permalink to this headline">¶</a></h3> <p>Pointer motion input event.</p> <div class="section" id="qapidoc-1657"> <h4>Members<a class="headerlink" href="#qapidoc-1657" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">axis</span></code>: <code class="docutils literal notranslate"><span class="pre">InputAxis</span></code></dt> <dd>Which axis is referenced by <code class="docutils literal notranslate"><span class="pre">value</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">value</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Pointer position. For absolute coordinates the valid range is 0 -> 0x7ffff</dd> </dl> </div> <div class="section" id="qapidoc-1658"> <h4>Since<a class="headerlink" href="#qapidoc-1658" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1662"> <h3><a class="toc-backref" href="#id220"><code class="docutils literal notranslate"><span class="pre">InputEventKind</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1662" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1660"> <h4>Values<a class="headerlink" href="#qapidoc-1660" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">key</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">btn</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">rel</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">abs</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1661"> <h4>Since<a class="headerlink" href="#qapidoc-1661" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1665"> <h3><a class="toc-backref" href="#id221"><code class="docutils literal notranslate"><span class="pre">InputKeyEventWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1665" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1663"> <h4>Members<a class="headerlink" href="#qapidoc-1663" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">InputKeyEvent</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1664"> <h4>Since<a class="headerlink" href="#qapidoc-1664" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1668"> <h3><a class="toc-backref" href="#id222"><code class="docutils literal notranslate"><span class="pre">InputBtnEventWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1668" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1666"> <h4>Members<a class="headerlink" href="#qapidoc-1666" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">InputBtnEvent</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1667"> <h4>Since<a class="headerlink" href="#qapidoc-1667" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1671"> <h3><a class="toc-backref" href="#id223"><code class="docutils literal notranslate"><span class="pre">InputMoveEventWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1671" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1669"> <h4>Members<a class="headerlink" href="#qapidoc-1669" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">InputMoveEvent</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1670"> <h4>Since<a class="headerlink" href="#qapidoc-1670" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1674"> <h3><a class="toc-backref" href="#id224"><code class="docutils literal notranslate"><span class="pre">InputEvent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1674" title="Permalink to this headline">¶</a></h3> <p>Input event union.</p> <div class="section" id="qapidoc-1672"> <h4>Members<a class="headerlink" href="#qapidoc-1672" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">InputEventKind</span></code></dt> <dd><p class="first">the input type, one of:</p> <ul class="last simple"> <li>‘key’: Input event of Keyboard</li> <li>‘btn’: Input event of pointer buttons</li> <li>‘rel’: Input event of relative pointer motion</li> <li>‘abs’: Input event of absolute pointer motion</li> </ul> </dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">InputKeyEventWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"key"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">InputBtnEventWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"btn"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">InputMoveEventWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"rel"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">InputMoveEventWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"abs"</span></code></dl> </div> <div class="section" id="qapidoc-1673"> <h4>Since<a class="headerlink" href="#qapidoc-1673" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-1680"> <h3><a class="toc-backref" href="#id225"><code class="docutils literal notranslate"><span class="pre">input-send-event</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1680" title="Permalink to this headline">¶</a></h3> <p>Send input event(s) to guest.</p> <p>The <code class="docutils literal notranslate"><span class="pre">device</span></code> and <code class="docutils literal notranslate"><span class="pre">head</span></code> parameters can be used to send the input event to specific input devices in case (a) multiple input devices of the same kind are added to the virtual machine and (b) you have configured input routing (see docs/multiseat.txt) for those input devices. The parameters work exactly like the device and head properties of input devices. If <code class="docutils literal notranslate"><span class="pre">device</span></code> is missing, only devices that have no input routing config are admissible. If <code class="docutils literal notranslate"><span class="pre">device</span></code> is specified, both input devices with and without input routing config are admissible, but devices with input routing config take precedence.</p> <div class="section" id="qapidoc-1675"> <h4>Arguments<a class="headerlink" href="#qapidoc-1675" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>display device to send event(s) to.</dd> <dt><code class="docutils literal notranslate"><span class="pre">head</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>head to send event(s) to, in case the display device supports multiple scanouts.</dd> <dt><code class="docutils literal notranslate"><span class="pre">events</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">InputEvent</span></code></dt> <dd>List of InputEvent union.</dd> </dl> </div> <div class="section" id="qapidoc-1676"> <h4>Returns<a class="headerlink" href="#qapidoc-1676" title="Permalink to this headline">¶</a></h4> <p>Nothing on success.</p> </div> <div class="section" id="qapidoc-1677"> <h4>Since<a class="headerlink" href="#qapidoc-1677" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-1678"> <h4>Note<a class="headerlink" href="#qapidoc-1678" title="Permalink to this headline">¶</a></h4> <p>The consoles are visible in the qom tree, under /backend/console[$index]. They have a device link and head property, so it is possible to map which console belongs to which device and display.</p> </div> <div class="section" id="qapidoc-1679"> <h4>Example<a class="headerlink" href="#qapidoc-1679" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Press</span> <span class="n">left</span> <span class="n">mouse</span> <span class="n">button</span><span class="o">.</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"input-send-event"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"video0"</span><span class="p">,</span> <span class="s2">"events"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"btn"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"down"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"button"</span><span class="p">:</span> <span class="s2">"left"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"input-send-event"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"video0"</span><span class="p">,</span> <span class="s2">"events"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"btn"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"down"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"button"</span><span class="p">:</span> <span class="s2">"left"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Press</span> <span class="n">ctrl</span><span class="o">-</span><span class="n">alt</span><span class="o">-</span><span class="k">del</span><span class="o">.</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"input-send-event"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"events"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"down"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"key"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"ctrl"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"down"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"key"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"alt"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"down"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"key"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qcode"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"delete"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">3.</span> <span class="n">Move</span> <span class="n">mouse</span> <span class="n">pointer</span> <span class="n">to</span> <span class="n">absolute</span> <span class="n">coordinates</span> <span class="p">(</span><span class="mi">20000</span><span class="p">,</span> <span class="mi">400</span><span class="p">)</span><span class="o">.</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"input-send-event"</span> <span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"events"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"abs"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"axis"</span><span class="p">:</span> <span class="s2">"x"</span><span class="p">,</span> <span class="s2">"value"</span> <span class="p">:</span> <span class="mi">20000</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"abs"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"axis"</span><span class="p">:</span> <span class="s2">"y"</span><span class="p">,</span> <span class="s2">"value"</span> <span class="p">:</span> <span class="mi">400</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1683"> <h3><a class="toc-backref" href="#id226"><code class="docutils literal notranslate"><span class="pre">DisplayGTK</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1683" title="Permalink to this headline">¶</a></h3> <p>GTK display options.</p> <div class="section" id="qapidoc-1681"> <h4>Members<a class="headerlink" href="#qapidoc-1681" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">grab-on-hover</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Grab keyboard input on mouse hover.</dd> <dt><code class="docutils literal notranslate"><span class="pre">zoom-to-fit</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Zoom guest display to fit into the host window. When turned off the host window will be resized instead. In case the display device can notify the guest on window resizes (virtio-gpu) this will default to “on”, assuming the guest will resize the display to match the window size then. Otherwise it defaults to “off”. Since 3.1</dd> </dl> </div> <div class="section" id="qapidoc-1682"> <h4>Since<a class="headerlink" href="#qapidoc-1682" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-1686"> <h3><a class="toc-backref" href="#id227"><code class="docutils literal notranslate"><span class="pre">DisplayEGLHeadless</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1686" title="Permalink to this headline">¶</a></h3> <p>EGL headless display options.</p> <div class="section" id="qapidoc-1684"> <h4>Members<a class="headerlink" href="#qapidoc-1684" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">rendernode</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Which DRM render node should be used. Default is the first available node on the host.</dd> </dl> </div> <div class="section" id="qapidoc-1685"> <h4>Since<a class="headerlink" href="#qapidoc-1685" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1689"> <h3><a class="toc-backref" href="#id228"><code class="docutils literal notranslate"><span class="pre">DisplayGLMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1689" title="Permalink to this headline">¶</a></h3> <p>Display OpenGL mode.</p> <div class="section" id="qapidoc-1687"> <h4>Values<a class="headerlink" href="#qapidoc-1687" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">off</span></code></dt> <dd>Disable OpenGL (default).</dd> <dt><code class="docutils literal notranslate"><span class="pre">on</span></code></dt> <dd>Use OpenGL, pick context type automatically. Would better be named ‘auto’ but is called ‘on’ for backward compatibility with bool type.</dd> <dt><code class="docutils literal notranslate"><span class="pre">core</span></code></dt> <dd>Use OpenGL with Core (desktop) Context.</dd> <dt><code class="docutils literal notranslate"><span class="pre">es</span></code></dt> <dd>Use OpenGL with ES (embedded systems) Context.</dd> </dl> </div> <div class="section" id="qapidoc-1688"> <h4>Since<a class="headerlink" href="#qapidoc-1688" title="Permalink to this headline">¶</a></h4> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-1692"> <h3><a class="toc-backref" href="#id229"><code class="docutils literal notranslate"><span class="pre">DisplayCurses</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1692" title="Permalink to this headline">¶</a></h3> <p>Curses display options.</p> <div class="section" id="qapidoc-1690"> <h4>Members<a class="headerlink" href="#qapidoc-1690" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">charset</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Font charset used by guest (default: CP437).</dd> </dl> </div> <div class="section" id="qapidoc-1691"> <h4>Since<a class="headerlink" href="#qapidoc-1691" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1695"> <h3><a class="toc-backref" href="#id230"><code class="docutils literal notranslate"><span class="pre">DisplayType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1695" title="Permalink to this headline">¶</a></h3> <p>Display (user interface) type.</p> <div class="section" id="qapidoc-1693"> <h4>Values<a class="headerlink" href="#qapidoc-1693" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">default</span></code></dt> <dd>The default user interface, selecting from the first available of gtk, sdl, cocoa, and vnc.</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>No user interface or video output display. The guest will still see an emulated graphics card, but its output will not be displayed to the QEMU user.</dd> <dt><code class="docutils literal notranslate"><span class="pre">gtk</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_GTK</span></code>)</dt> <dd>The GTK user interface.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sdl</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SDL</span></code>)</dt> <dd>The SDL user interface.</dd> <dt><code class="docutils literal notranslate"><span class="pre">egl-headless</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_OPENGL</span> <span class="pre">and</span> <span class="pre">CONFIG_GBM</span></code>)</dt> <dd>No user interface, offload GL operations to a local DRI device. Graphical display need to be paired with VNC or Spice. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">curses</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_CURSES</span></code>)</dt> <dd>Display video output via curses. For graphics device models which support a text mode, QEMU can display this output using a curses/ncurses interface. Nothing is displayed when the graphics device is in graphical mode or if the graphics device does not support a text mode. Generally only the VGA device models support text mode.</dd> <dt><code class="docutils literal notranslate"><span class="pre">cocoa</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_COCOA</span></code>)</dt> <dd>The Cocoa user interface.</dd> <dt><code class="docutils literal notranslate"><span class="pre">spice-app</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SPICE</span></code>)</dt> <dd>Set up a Spice server and run the default associated application to connect to it. The server will redirect the serial console and QEMU monitors. (Since 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-1694"> <h4>Since<a class="headerlink" href="#qapidoc-1694" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-1698"> <h3><a class="toc-backref" href="#id231"><code class="docutils literal notranslate"><span class="pre">DisplayOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1698" title="Permalink to this headline">¶</a></h3> <p>Display (user interface) options.</p> <div class="section" id="qapidoc-1696"> <h4>Members<a class="headerlink" href="#qapidoc-1696" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">DisplayType</span></code></dt> <dd>Which DisplayType qemu should use.</dd> <dt><code class="docutils literal notranslate"><span class="pre">full-screen</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Start user interface in fullscreen mode (default: off).</dd> <dt><code class="docutils literal notranslate"><span class="pre">window-close</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Allow to quit qemu with window close button (default: on).</dd> <dt><code class="docutils literal notranslate"><span class="pre">show-cursor</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Force showing the mouse cursor (default: off). (since: 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">gl</span></code>: <code class="docutils literal notranslate"><span class="pre">DisplayGLMode</span></code> (optional)</dt> <dd>Enable OpenGL support (default: off).</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">DisplayGTK</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"gtk"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_GTK</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">DisplayCurses</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"curses"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_CURSES</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">DisplayEGLHeadless</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"egl-headless"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_OPENGL</span> <span class="pre">and</span> <span class="pre">CONFIG_GBM</span></code>)</dl> </div> <div class="section" id="qapidoc-1697"> <h4>Since<a class="headerlink" href="#qapidoc-1697" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-1701"> <h3><a class="toc-backref" href="#id232"><code class="docutils literal notranslate"><span class="pre">query-display-options</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1701" title="Permalink to this headline">¶</a></h3> <p>Returns information about display configuration</p> <div class="section" id="qapidoc-1699"> <h4>Returns<a class="headerlink" href="#qapidoc-1699" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">DisplayOptions</span></code></p> </div> <div class="section" id="qapidoc-1700"> <h4>Since<a class="headerlink" href="#qapidoc-1700" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1704"> <h3><a class="toc-backref" href="#id233"><code class="docutils literal notranslate"><span class="pre">DisplayReloadType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1704" title="Permalink to this headline">¶</a></h3> <p>Available DisplayReload types.</p> <div class="section" id="qapidoc-1702"> <h4>Values<a class="headerlink" href="#qapidoc-1702" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">vnc</span></code></dt> <dd>VNC display</dd> </dl> </div> <div class="section" id="qapidoc-1703"> <h4>Since<a class="headerlink" href="#qapidoc-1703" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1707"> <h3><a class="toc-backref" href="#id234"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptionsVNC</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1707" title="Permalink to this headline">¶</a></h3> <p>Specify the VNC reload options.</p> <div class="section" id="qapidoc-1705"> <h4>Members<a class="headerlink" href="#qapidoc-1705" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">tls-certs</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>reload tls certs or not.</dd> </dl> </div> <div class="section" id="qapidoc-1706"> <h4>Since<a class="headerlink" href="#qapidoc-1706" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1710"> <h3><a class="toc-backref" href="#id235"><code class="docutils literal notranslate"><span class="pre">DisplayReloadOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1710" title="Permalink to this headline">¶</a></h3> <p>Options of the display configuration reload.</p> <div class="section" id="qapidoc-1708"> <h4>Members<a class="headerlink" href="#qapidoc-1708" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">DisplayReloadType</span></code></dt> <dd>Specify the display type.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">DisplayReloadOptionsVNC</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"vnc"</span></code></dl> </div> <div class="section" id="qapidoc-1709"> <h4>Since<a class="headerlink" href="#qapidoc-1709" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1715"> <h3><a class="toc-backref" href="#id236"><code class="docutils literal notranslate"><span class="pre">display-reload</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1715" title="Permalink to this headline">¶</a></h3> <p>Reload display configuration.</p> <div class="section" id="qapidoc-1711"> <h4>Arguments<a class="headerlink" href="#qapidoc-1711" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">DisplayReloadOptions</span></code></dl> </div> <div class="section" id="qapidoc-1712"> <h4>Returns<a class="headerlink" href="#qapidoc-1712" title="Permalink to this headline">¶</a></h4> <p>Nothing on success.</p> </div> <div class="section" id="qapidoc-1713"> <h4>Since<a class="headerlink" href="#qapidoc-1713" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> <div class="section" id="qapidoc-1714"> <h4>Example<a class="headerlink" href="#qapidoc-1714" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"display-reload"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"vnc"</span><span class="p">,</span> <span class="s2">"tls-certs"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-1716"> <h2><a class="toc-backref" href="#id237">User authorization</a><a class="headerlink" href="#qapidoc-1716" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1719"> <h3><a class="toc-backref" href="#id238"><code class="docutils literal notranslate"><span class="pre">QAuthZListPolicy</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1719" title="Permalink to this headline">¶</a></h3> <p>The authorization policy result</p> <div class="section" id="qapidoc-1717"> <h4>Values<a class="headerlink" href="#qapidoc-1717" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deny</span></code></dt> <dd>deny access</dd> <dt><code class="docutils literal notranslate"><span class="pre">allow</span></code></dt> <dd>allow access</dd> </dl> </div> <div class="section" id="qapidoc-1718"> <h4>Since<a class="headerlink" href="#qapidoc-1718" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1722"> <h3><a class="toc-backref" href="#id239"><code class="docutils literal notranslate"><span class="pre">QAuthZListFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1722" title="Permalink to this headline">¶</a></h3> <p>The authorization policy match format</p> <div class="section" id="qapidoc-1720"> <h4>Values<a class="headerlink" href="#qapidoc-1720" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">exact</span></code></dt> <dd>an exact string match</dd> <dt><code class="docutils literal notranslate"><span class="pre">glob</span></code></dt> <dd>string with ? and * shell wildcard support</dd> </dl> </div> <div class="section" id="qapidoc-1721"> <h4>Since<a class="headerlink" href="#qapidoc-1721" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1725"> <h3><a class="toc-backref" href="#id240"><code class="docutils literal notranslate"><span class="pre">QAuthZListRule</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1725" title="Permalink to this headline">¶</a></h3> <p>A single authorization rule.</p> <div class="section" id="qapidoc-1723"> <h4>Members<a class="headerlink" href="#qapidoc-1723" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">match</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>a string or glob to match against a user identity</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">QAuthZListPolicy</span></code></dt> <dd>the result to return if <code class="docutils literal notranslate"><span class="pre">match</span></code> evaluates to true</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">QAuthZListFormat</span></code> (optional)</dt> <dd>the format of the <code class="docutils literal notranslate"><span class="pre">match</span></code> rule (default ‘exact’)</dd> </dl> </div> <div class="section" id="qapidoc-1724"> <h4>Since<a class="headerlink" href="#qapidoc-1724" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1728"> <h3><a class="toc-backref" href="#id241"><code class="docutils literal notranslate"><span class="pre">AuthZListProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1728" title="Permalink to this headline">¶</a></h3> <p>Properties for authz-list objects.</p> <div class="section" id="qapidoc-1726"> <h4>Members<a class="headerlink" href="#qapidoc-1726" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">QAuthZListPolicy</span></code> (optional)</dt> <dd>Default policy to apply when no rule matches (default: deny)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rules</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">QAuthZListRule</span></code> (optional)</dt> <dd>Authorization rules based on matching user</dd> </dl> </div> <div class="section" id="qapidoc-1727"> <h4>Since<a class="headerlink" href="#qapidoc-1727" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1731"> <h3><a class="toc-backref" href="#id242"><code class="docutils literal notranslate"><span class="pre">AuthZListFileProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1731" title="Permalink to this headline">¶</a></h3> <p>Properties for authz-listfile objects.</p> <div class="section" id="qapidoc-1729"> <h4>Members<a class="headerlink" href="#qapidoc-1729" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>File name to load the configuration from. The file must contain valid JSON for AuthZListProperties.</dd> <dt><code class="docutils literal notranslate"><span class="pre">refresh</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>If true, inotify is used to monitor the file, automatically reloading changes. If an error occurs during reloading, all authorizations will fail until the file is next successfully loaded. (default: true if the binary was built with CONFIG_INOTIFY1, false otherwise)</dd> </dl> </div> <div class="section" id="qapidoc-1730"> <h4>Since<a class="headerlink" href="#qapidoc-1730" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1734"> <h3><a class="toc-backref" href="#id243"><code class="docutils literal notranslate"><span class="pre">AuthZPAMProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1734" title="Permalink to this headline">¶</a></h3> <p>Properties for authz-pam objects.</p> <div class="section" id="qapidoc-1732"> <h4>Members<a class="headerlink" href="#qapidoc-1732" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">service</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>PAM service name to use for authorization</dd> </dl> </div> <div class="section" id="qapidoc-1733"> <h4>Since<a class="headerlink" href="#qapidoc-1733" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1737"> <h3><a class="toc-backref" href="#id244"><code class="docutils literal notranslate"><span class="pre">AuthZSimpleProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1737" title="Permalink to this headline">¶</a></h3> <p>Properties for authz-simple objects.</p> <div class="section" id="qapidoc-1735"> <h4>Members<a class="headerlink" href="#qapidoc-1735" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">identity</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Identifies the allowed user. Its format depends on the network service that authorization object is associated with. For authorizing based on TLS x509 certificates, the identity must be the x509 distinguished name.</dd> </dl> </div> <div class="section" id="qapidoc-1736"> <h4>Since<a class="headerlink" href="#qapidoc-1736" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> </div> <div class="section" id="qapidoc-1738"> <h2><a class="toc-backref" href="#id245">Migration</a><a class="headerlink" href="#qapidoc-1738" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1741"> <h3><a class="toc-backref" href="#id246"><code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1741" title="Permalink to this headline">¶</a></h3> <p>Detailed migration status.</p> <div class="section" id="qapidoc-1739"> <h4>Members<a class="headerlink" href="#qapidoc-1739" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">transferred</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of bytes already transferred to the target VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">remaining</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of bytes remaining to be transferred to the target VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">total</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>total amount of bytes involved in the migration process</dd> <dt><code class="docutils literal notranslate"><span class="pre">duplicate</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of duplicate (zero) pages (since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">skipped</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of skipped zero pages (since 1.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">normal</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of normal pages (since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">normal-bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of normal bytes sent (since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-pages-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of pages dirtied by second by the guest (since 1.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mbps</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>throughput in megabits/sec. (since 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-sync-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of times that dirty ram was synchronized (since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-requests</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of page requests received from the destination (since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">page-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes per page for the various page-based statistics (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes sent through multifd (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">pages-per-second</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the number of memory pages transferred per second (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">precopy-bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes sent in the pre-copy phase (since 7.0).</dd> <dt><code class="docutils literal notranslate"><span class="pre">downtime-bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes sent while the guest is paused (since 7.0).</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The number of bytes sent during the post-copy phase (since 7.0).</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-sync-missed-zero-copy</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of times dirty RAM synchronization could not avoid copying dirty pages. This is between 0 and <code class="docutils literal notranslate"><span class="pre">dirty-sync-count</span></code> * <code class="docutils literal notranslate"><span class="pre">multifd-channels</span></code>. (since 7.1)</dd> </dl> </div> <div class="section" id="qapidoc-1740"> <h4>Since<a class="headerlink" href="#qapidoc-1740" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-1744"> <h3><a class="toc-backref" href="#id247"><code class="docutils literal notranslate"><span class="pre">XBZRLECacheStats</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1744" title="Permalink to this headline">¶</a></h3> <p>Detailed XBZRLE migration cache statistics</p> <div class="section" id="qapidoc-1742"> <h4>Members<a class="headerlink" href="#qapidoc-1742" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>XBZRLE cache size</dd> <dt><code class="docutils literal notranslate"><span class="pre">bytes</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of bytes already transferred to the target VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">pages</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of pages transferred to the target VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache-miss</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of cache miss</dd> <dt><code class="docutils literal notranslate"><span class="pre">cache-miss-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>rate of cache miss (since 2.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">encoding-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>rate of encoded bytes (since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">overflow</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of overflows</dd> </dl> </div> <div class="section" id="qapidoc-1743"> <h4>Since<a class="headerlink" href="#qapidoc-1743" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1747"> <h3><a class="toc-backref" href="#id248"><code class="docutils literal notranslate"><span class="pre">CompressionStats</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1747" title="Permalink to this headline">¶</a></h3> <p>Detailed migration compression statistics</p> <div class="section" id="qapidoc-1745"> <h4>Members<a class="headerlink" href="#qapidoc-1745" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pages</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of pages compressed and transferred to the target VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">busy</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>count of times that no free thread was available to compress data</dd> <dt><code class="docutils literal notranslate"><span class="pre">busy-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>rate of thread busy</dd> <dt><code class="docutils literal notranslate"><span class="pre">compressed-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of bytes after compression</dd> <dt><code class="docutils literal notranslate"><span class="pre">compression-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>rate of compressed size</dd> </dl> </div> <div class="section" id="qapidoc-1746"> <h4>Since<a class="headerlink" href="#qapidoc-1746" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1750"> <h3><a class="toc-backref" href="#id249"><code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1750" title="Permalink to this headline">¶</a></h3> <p>An enumeration of migration status.</p> <div class="section" id="qapidoc-1748"> <h4>Values<a class="headerlink" href="#qapidoc-1748" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>no migration has ever happened.</dd> <dt><code class="docutils literal notranslate"><span class="pre">setup</span></code></dt> <dd>migration process has been initiated.</dd> <dt><code class="docutils literal notranslate"><span class="pre">cancelling</span></code></dt> <dd>in the process of cancelling migration.</dd> <dt><code class="docutils literal notranslate"><span class="pre">cancelled</span></code></dt> <dd>cancelling migration is finished.</dd> <dt><code class="docutils literal notranslate"><span class="pre">active</span></code></dt> <dd>in the process of doing migration.</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-active</span></code></dt> <dd>like active, but now in postcopy mode. (since 2.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-paused</span></code></dt> <dd>during postcopy but paused. (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-recover</span></code></dt> <dd>trying to recover from a paused postcopy. (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">completed</span></code></dt> <dd>migration is finished.</dd> <dt><code class="docutils literal notranslate"><span class="pre">failed</span></code></dt> <dd>some error occurred during migration process.</dd> <dt><code class="docutils literal notranslate"><span class="pre">colo</span></code></dt> <dd>VM is in the process of fault tolerance, VM can not get into this state unless colo capability is enabled for migration. (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">pre-switchover</span></code></dt> <dd>Paused before device serialisation. (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code></dt> <dd>During device serialisation when pause-before-switchover is enabled (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">wait-unplug</span></code></dt> <dd>wait for device unplug request by guest OS to be completed. (since 4.2)</dd> </dl> </div> <div class="section" id="qapidoc-1749"> <h4>Since<a class="headerlink" href="#qapidoc-1749" title="Permalink to this headline">¶</a></h4> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-1753"> <h3><a class="toc-backref" href="#id250"><code class="docutils literal notranslate"><span class="pre">VfioStats</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1753" title="Permalink to this headline">¶</a></h3> <p>Detailed VFIO devices migration statistics</p> <div class="section" id="qapidoc-1751"> <h4>Members<a class="headerlink" href="#qapidoc-1751" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">transferred</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>amount of bytes transferred to the target VM by VFIO devices</dd> </dl> </div> <div class="section" id="qapidoc-1752"> <h4>Since<a class="headerlink" href="#qapidoc-1752" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1756"> <h3><a class="toc-backref" href="#id251"><code class="docutils literal notranslate"><span class="pre">MigrationInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1756" title="Permalink to this headline">¶</a></h3> <p>Information about current migration process.</p> <div class="section" id="qapidoc-1754"> <h4>Members<a class="headerlink" href="#qapidoc-1754" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> describing the current migration status. If this field is not returned, no migration process has been initiated</dd> <dt><code class="docutils literal notranslate"><span class="pre">ram</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> containing detailed migration status, only returned if status is ‘active’ or ‘completed’(since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">disk</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">MigrationStats</span></code> containing detailed disk migration status, only returned if status is ‘active’ and it is a block migration</dd> <dt><code class="docutils literal notranslate"><span class="pre">xbzrle-cache</span></code>: <code class="docutils literal notranslate"><span class="pre">XBZRLECacheStats</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">XBZRLECacheStats</span></code> containing detailed XBZRLE migration statistics, only returned if XBZRLE feature is on and status is ‘active’ or ‘completed’ (since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">total-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total amount of milliseconds since migration started. If migration has ended, it returns the total migration time. (since 1.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">downtime</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>only present when migration finishes correctly total downtime in milliseconds for the guest. (since 1.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">expected-downtime</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>only present while migration is active expected downtime in milliseconds for the guest in last walk of the dirty bitmap. (since 1.3)</dd> <dt><code class="docutils literal notranslate"><span class="pre">setup-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>amount of setup time in milliseconds <em>before</em> the iterations begin but <em>after</em> the QMP command is issued. This is designed to provide an accounting of any activities (such as RDMA pinning) which may be expensive, but do not actually occur during the iterative migration rounds themselves. (since 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-percentage</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>percentage of time guest cpus are being throttled during auto-converge. This is only present when auto-converge has started throttling guest cpus. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">error-desc</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the human readable error description string, when <code class="docutils literal notranslate"><span class="pre">status</span></code> is ‘failed’. Clients should not attempt to parse the error strings. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-blocktime</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>total time when all vCPU were blocked during postcopy live migration. This is only present when the postcopy-blocktime migration capability is enabled. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-vcpu-blocktime</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>list of the postcopy blocktime per vCPU. This is only present when the postcopy-blocktime migration capability is enabled. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compression</span></code>: <code class="docutils literal notranslate"><span class="pre">CompressionStats</span></code> (optional)</dt> <dd>migration compression statistics, only returned if compression feature is on and status is ‘active’ or ‘completed’ (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">socket-address</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SocketAddress</span></code> (optional)</dt> <dd>Only used for tcp, to know what the real port is (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">vfio</span></code>: <code class="docutils literal notranslate"><span class="pre">VfioStats</span></code> (optional)</dt> <dd><code class="docutils literal notranslate"><span class="pre">VfioStats</span></code> containing detailed VFIO devices migration statistics, only returned if VFIO device is present, migration is supported by all VFIO devices and status is ‘active’ or ‘completed’ (since 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">blocked-reasons</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>A list of reasons an outgoing migration is blocked. Present and non-empty when migration is blocked. (since 6.0)</dd> </dl> </div> <div class="section" id="qapidoc-1755"> <h4>Since<a class="headerlink" href="#qapidoc-1755" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-1760"> <h3><a class="toc-backref" href="#id252"><code class="docutils literal notranslate"><span class="pre">query-migrate</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1760" title="Permalink to this headline">¶</a></h3> <p>Returns information about current migration process. If migration is active there will be another json-object with RAM migration status and if block migration is active another one with block migration status.</p> <div class="section" id="qapidoc-1757"> <h4>Returns<a class="headerlink" href="#qapidoc-1757" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">MigrationInfo</span></code></p> </div> <div class="section" id="qapidoc-1758"> <h4>Since<a class="headerlink" href="#qapidoc-1758" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1759"> <h4>Example<a class="headerlink" href="#qapidoc-1759" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Before</span> <span class="n">the</span> <span class="n">first</span> <span class="n">migration</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Migration</span> <span class="ow">is</span> <span class="n">done</span> <span class="ow">and</span> <span class="n">has</span> <span class="n">succeeded</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"completed"</span><span class="p">,</span> <span class="s2">"total-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"setup-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"downtime"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"ram"</span><span class="p">:{</span> <span class="s2">"transferred"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"remaining"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"total"</span><span class="p">:</span><span class="mi">246</span><span class="p">,</span> <span class="s2">"duplicate"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal-bytes"</span><span class="p">:</span><span class="mi">123456</span><span class="p">,</span> <span class="s2">"dirty-sync-count"</span><span class="p">:</span><span class="mi">15</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="mf">3.</span> <span class="n">Migration</span> <span class="ow">is</span> <span class="n">done</span> <span class="ow">and</span> <span class="n">has</span> <span class="n">failed</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"failed"</span> <span class="p">}</span> <span class="p">}</span> <span class="mf">4.</span> <span class="n">Migration</span> <span class="ow">is</span> <span class="n">being</span> <span class="n">performed</span> <span class="ow">and</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">a</span> <span class="n">block</span> <span class="n">migration</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:{</span> <span class="s2">"status"</span><span class="p">:</span><span class="s2">"active"</span><span class="p">,</span> <span class="s2">"total-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"setup-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"expected-downtime"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"ram"</span><span class="p">:{</span> <span class="s2">"transferred"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"remaining"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"total"</span><span class="p">:</span><span class="mi">246</span><span class="p">,</span> <span class="s2">"duplicate"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal-bytes"</span><span class="p">:</span><span class="mi">123456</span><span class="p">,</span> <span class="s2">"dirty-sync-count"</span><span class="p">:</span><span class="mi">15</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="mf">5.</span> <span class="n">Migration</span> <span class="ow">is</span> <span class="n">being</span> <span class="n">performed</span> <span class="ow">and</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">block</span> <span class="n">migration</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:{</span> <span class="s2">"status"</span><span class="p">:</span><span class="s2">"active"</span><span class="p">,</span> <span class="s2">"total-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"setup-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"expected-downtime"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"ram"</span><span class="p">:{</span> <span class="s2">"total"</span><span class="p">:</span><span class="mi">1057024</span><span class="p">,</span> <span class="s2">"remaining"</span><span class="p">:</span><span class="mi">1053304</span><span class="p">,</span> <span class="s2">"transferred"</span><span class="p">:</span><span class="mi">3720</span><span class="p">,</span> <span class="s2">"duplicate"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal"</span><span class="p">:</span><span class="mi">123</span><span class="p">,</span> <span class="s2">"normal-bytes"</span><span class="p">:</span><span class="mi">123456</span><span class="p">,</span> <span class="s2">"dirty-sync-count"</span><span class="p">:</span><span class="mi">15</span> <span class="p">},</span> <span class="s2">"disk"</span><span class="p">:{</span> <span class="s2">"total"</span><span class="p">:</span><span class="mi">20971520</span><span class="p">,</span> <span class="s2">"remaining"</span><span class="p">:</span><span class="mi">20880384</span><span class="p">,</span> <span class="s2">"transferred"</span><span class="p">:</span><span class="mi">91136</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> <span class="mf">6.</span> <span class="n">Migration</span> <span class="ow">is</span> <span class="n">being</span> <span class="n">performed</span> <span class="ow">and</span> <span class="n">XBZRLE</span> <span class="ow">is</span> <span class="n">active</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:{</span> <span class="s2">"status"</span><span class="p">:</span><span class="s2">"active"</span><span class="p">,</span> <span class="s2">"total-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"setup-time"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"expected-downtime"</span><span class="p">:</span><span class="mi">12345</span><span class="p">,</span> <span class="s2">"ram"</span><span class="p">:{</span> <span class="s2">"total"</span><span class="p">:</span><span class="mi">1057024</span><span class="p">,</span> <span class="s2">"remaining"</span><span class="p">:</span><span class="mi">1053304</span><span class="p">,</span> <span class="s2">"transferred"</span><span class="p">:</span><span class="mi">3720</span><span class="p">,</span> <span class="s2">"duplicate"</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span> <span class="s2">"normal"</span><span class="p">:</span><span class="mi">3333</span><span class="p">,</span> <span class="s2">"normal-bytes"</span><span class="p">:</span><span class="mi">3412992</span><span class="p">,</span> <span class="s2">"dirty-sync-count"</span><span class="p">:</span><span class="mi">15</span> <span class="p">},</span> <span class="s2">"xbzrle-cache"</span><span class="p">:{</span> <span class="s2">"cache-size"</span><span class="p">:</span><span class="mi">67108864</span><span class="p">,</span> <span class="s2">"bytes"</span><span class="p">:</span><span class="mi">20971520</span><span class="p">,</span> <span class="s2">"pages"</span><span class="p">:</span><span class="mi">2444343</span><span class="p">,</span> <span class="s2">"cache-miss"</span><span class="p">:</span><span class="mi">2244</span><span class="p">,</span> <span class="s2">"cache-miss-rate"</span><span class="p">:</span><span class="mf">0.123</span><span class="p">,</span> <span class="s2">"encoding-rate"</span><span class="p">:</span><span class="mf">80.1</span><span class="p">,</span> <span class="s2">"overflow"</span><span class="p">:</span><span class="mi">34434</span> <span class="p">}</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1764"> <h3><a class="toc-backref" href="#id253"><code class="docutils literal notranslate"><span class="pre">MigrationCapability</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1764" title="Permalink to this headline">¶</a></h3> <p>Migration capabilities enumeration</p> <div class="section" id="qapidoc-1761"> <h4>Values<a class="headerlink" href="#qapidoc-1761" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">xbzrle</span></code></dt> <dd>Migration supports xbzrle (Xor Based Zero Run Length Encoding). This feature allows us to minimize migration traffic for certain work loads, by sending compressed difference of the pages</dd> <dt><code class="docutils literal notranslate"><span class="pre">rdma-pin-all</span></code></dt> <dd>Controls whether or not the entire VM memory footprint is mlock()’d on demand or all at once. Refer to docs/rdma.txt for usage. Disabled by default. (since 2.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">zero-blocks</span></code></dt> <dd>During storage migration encode blocks of zeroes efficiently. This essentially saves 1MB of zeroes per block on the wire. Enabling requires source and target VM to support this feature. To enable it is sufficient to enable the capability on the source VM. The feature is disabled by default. (since 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress</span></code></dt> <dd>Use multiple compression threads to accelerate live migration. This feature can help to reduce the migration traffic, by sending compressed pages. Please note that if compress and xbzrle are both on, compress only takes effect in the ram bulk stage, after that, it will be disabled and only xbzrle takes effect, this can help to minimize migration traffic. The feature is disabled by default. (since 2.4 )</dd> <dt><code class="docutils literal notranslate"><span class="pre">events</span></code></dt> <dd>generate events for each migration state change (since 2.4 )</dd> <dt><code class="docutils literal notranslate"><span class="pre">auto-converge</span></code></dt> <dd>If enabled, QEMU will automatically throttle down the guest to speed up convergence of RAM migration. (since 1.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-ram</span></code></dt> <dd>Start executing on the migration target before all of RAM has been migrated, pulling the remaining pages along as needed. The capacity must have the same setting on both source and target or migration will not even start. NOTE: If the migration fails during postcopy the VM will fail. (since 2.6)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-colo</span></code></dt> <dd>If enabled, migration will never end, and the state of the VM on the primary side will be migrated continuously to the VM on secondary side, this process is called COarse-Grain LOck Stepping (COLO) for Non-stop Service. (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">release-ram</span></code></dt> <dd>if enabled, qemu will free the migrated ram pages on the source during postcopy-ram migration. (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block</span></code></dt> <dd>If enabled, QEMU will also migrate the contents of all block devices. Default is disabled. A possible alternative uses mirror jobs to a builtin NBD server on the destination, which offers more flexibility. (Since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">return-path</span></code></dt> <dd>If enabled, migration will use the return path even for precopy. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">pause-before-switchover</span></code></dt> <dd>Pause outgoing migration before serialising device state and before disabling block IO (since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd</span></code></dt> <dd>Use more than one fd for migration (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-bitmaps</span></code></dt> <dd>If enabled, QEMU will migrate named dirty bitmaps. (since 2.12)</dd> <dt><code class="docutils literal notranslate"><span class="pre">postcopy-blocktime</span></code></dt> <dd>Calculate downtime for postcopy live migration (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">late-block-activate</span></code></dt> <dd>If enabled, the destination will not activate block devices (and thus take locks) immediately at the end of migration. (since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-ignore-shared</span></code></dt> <dd>If enabled, QEMU will not migrate shared memory (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">validate-uuid</span></code></dt> <dd>Send the UUID of the source to allow the destination to ensure it is the same. (since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">background-snapshot</span></code></dt> <dd>If enabled, the migration stream will be a snapshot of the VM exactly at the point when the migration procedure starts. The VM RAM is saved with running VM. (since 6.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">zero-copy-send</span></code></dt> <dd>Controls behavior on sending memory pages on migration. When true, enables a zero-copy mechanism for sending memory pages, if host supports it. Requires that QEMU be permitted to use locked memory for guest RAM pages. (since 7.1)</dd> </dl> </div> <div class="section" id="qapidoc-1762"> <h4>Features<a class="headerlink" href="#qapidoc-1762" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Members <code class="docutils literal notranslate"><span class="pre">x-colo</span></code> and <code class="docutils literal notranslate"><span class="pre">x-ignore-shared</span></code> are experimental.</dd> </dl> </div> <div class="section" id="qapidoc-1763"> <h4>Since<a class="headerlink" href="#qapidoc-1763" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1767"> <h3><a class="toc-backref" href="#id254"><code class="docutils literal notranslate"><span class="pre">MigrationCapabilityStatus</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1767" title="Permalink to this headline">¶</a></h3> <p>Migration capability information</p> <div class="section" id="qapidoc-1765"> <h4>Members<a class="headerlink" href="#qapidoc-1765" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">capability</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationCapability</span></code></dt> <dd>capability enum</dd> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>capability state bool</dd> </dl> </div> <div class="section" id="qapidoc-1766"> <h4>Since<a class="headerlink" href="#qapidoc-1766" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-1771"> <h3><a class="toc-backref" href="#id255"><code class="docutils literal notranslate"><span class="pre">migrate-set-capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1771" title="Permalink to this headline">¶</a></h3> <p>Enable/Disable the following migration capabilities (like xbzrle)</p> <div class="section" id="qapidoc-1768"> <h4>Arguments<a class="headerlink" href="#qapidoc-1768" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">capabilities</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">MigrationCapabilityStatus</span></code></dt> <dd>json array of capability modifications to make</dd> </dl> </div> <div class="section" id="qapidoc-1769"> <h4>Since<a class="headerlink" href="#qapidoc-1769" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-1770"> <h4>Example<a class="headerlink" href="#qapidoc-1770" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-set-capabilities"</span> <span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"capabilities"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"xbzrle"</span><span class="p">,</span> <span class="s2">"state"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1775"> <h3><a class="toc-backref" href="#id256"><code class="docutils literal notranslate"><span class="pre">query-migrate-capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1775" title="Permalink to this headline">¶</a></h3> <p>Returns information about the current migration capabilities status</p> <div class="section" id="qapidoc-1772"> <h4>Returns<a class="headerlink" href="#qapidoc-1772" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">MigrationCapabilitiesStatus</span></code></p> </div> <div class="section" id="qapidoc-1773"> <h4>Since<a class="headerlink" href="#qapidoc-1773" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-1774"> <h4>Example<a class="headerlink" href="#qapidoc-1774" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate-capabilities"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"xbzrle"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"rdma-pin-all"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"auto-converge"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"zero-blocks"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"compress"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"events"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"postcopy-ram"</span><span class="p">},</span> <span class="p">{</span><span class="s2">"state"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"capability"</span><span class="p">:</span> <span class="s2">"x-colo"</span><span class="p">}</span> <span class="p">]}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1778"> <h3><a class="toc-backref" href="#id257"><code class="docutils literal notranslate"><span class="pre">MultiFDCompression</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1778" title="Permalink to this headline">¶</a></h3> <p>An enumeration of multifd compression methods.</p> <div class="section" id="qapidoc-1776"> <h4>Values<a class="headerlink" href="#qapidoc-1776" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>no compression.</dd> <dt><code class="docutils literal notranslate"><span class="pre">zlib</span></code></dt> <dd>use zlib compression method.</dd> <dt><code class="docutils literal notranslate"><span class="pre">zstd</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_ZSTD</span></code>)</dt> <dd>use zstd compression method.</dd> </dl> </div> <div class="section" id="qapidoc-1777"> <h4>Since<a class="headerlink" href="#qapidoc-1777" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-1781"> <h3><a class="toc-backref" href="#id258"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAliasTransform</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1781" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1779"> <h4>Members<a class="headerlink" href="#qapidoc-1779" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">persistent</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>If present, the bitmap will be made persistent or transient depending on this parameter.</dd> </dl> </div> <div class="section" id="qapidoc-1780"> <h4>Since<a class="headerlink" href="#qapidoc-1780" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1784"> <h3><a class="toc-backref" href="#id259"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAlias</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1784" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1782"> <h4>Members<a class="headerlink" href="#qapidoc-1782" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The name of the bitmap.</dd> <dt><code class="docutils literal notranslate"><span class="pre">alias</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>An alias name for migration (for example the bitmap name on the opposite site).</dd> <dt><code class="docutils literal notranslate"><span class="pre">transform</span></code>: <code class="docutils literal notranslate"><span class="pre">BitmapMigrationBitmapAliasTransform</span></code> (optional)</dt> <dd>Allows the modification of the migrated bitmap. (since 6.0)</dd> </dl> </div> <div class="section" id="qapidoc-1783"> <h4>Since<a class="headerlink" href="#qapidoc-1783" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1787"> <h3><a class="toc-backref" href="#id260"><code class="docutils literal notranslate"><span class="pre">BitmapMigrationNodeAlias</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1787" title="Permalink to this headline">¶</a></h3> <p>Maps a block node name and the bitmaps it has to aliases for dirty bitmap migration.</p> <div class="section" id="qapidoc-1785"> <h4>Members<a class="headerlink" href="#qapidoc-1785" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>A block node name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">alias</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>An alias block node name for migration (for example the node name on the opposite site).</dd> <dt><code class="docutils literal notranslate"><span class="pre">bitmaps</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BitmapMigrationBitmapAlias</span></code></dt> <dd>Mappings for the bitmaps on this node.</dd> </dl> </div> <div class="section" id="qapidoc-1786"> <h4>Since<a class="headerlink" href="#qapidoc-1786" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1791"> <h3><a class="toc-backref" href="#id261"><code class="docutils literal notranslate"><span class="pre">MigrationParameter</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1791" title="Permalink to this headline">¶</a></h3> <p>Migration parameters enumeration</p> <div class="section" id="qapidoc-1788"> <h4>Values<a class="headerlink" href="#qapidoc-1788" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">announce-initial</span></code></dt> <dd>Initial delay (in milliseconds) before sending the first announce (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-max</span></code></dt> <dd>Maximum delay (in milliseconds) between packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-rounds</span></code></dt> <dd>Number of self-announce packets sent after migration (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-step</span></code></dt> <dd>Increase in delay (in milliseconds) between subsequent packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-level</span></code></dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 9, where 0 means no compression, 1 means the best compression speed, and 9 means best compression ratio which will consume more CPU.</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-threads</span></code></dt> <dd>Set compression thread count to be used in live migration, the compression thread count is an integer between 1 and 255.</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-wait-thread</span></code></dt> <dd>Controls behavior when all compression threads are currently busy. If true (default), wait for a free compression thread to become available; otherwise, send the page uncompressed. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">decompress-threads</span></code></dt> <dd>Set decompression thread count to be used in live migration, the decompression thread count is an integer between 1 and 255. Usually, decompression is at least 4 times as fast as compression, so set the decompress-threads to the number about 1/4 of compress-threads is adequate.</dd> <dt><code class="docutils literal notranslate"><span class="pre">throttle-trigger-threshold</span></code></dt> <dd>The ratio of bytes_dirty_period and bytes_xfer_period to trigger throttling. It is expressed as percentage. The default value is 50. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-initial</span></code></dt> <dd>Initial percentage of time guest cpus are throttled when migration auto-converge is activated. The default value is 20. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code></dt> <dd>throttle percentage increase each time auto-converge detects that migration is not making progress. The default value is 10. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-tailslow</span></code></dt> <dd>Make CPU throttling slower at tail stage At the tail stage of throttling, the Guest is very sensitive to CPU percentage while the <code class="docutils literal notranslate"><span class="pre">cpu-throttle</span></code> -increment is excessive usually at tail stage. If this parameter is true, we will compute the ideal CPU percentage used by the Guest, which may exactly make the dirty rate match the dirty rate threshold. Then we will choose a smaller throttle increment between the one specified by <code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code> and the one generated by ideal CPU percentage. Therefore, it is compatible to traditional throttling, meanwhile the throttle increment won’t be excessive at tail stage. The default value is false. (Since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code></dt> <dd>ID of the ‘tls-creds’ object that provides credentials for establishing a TLS connection over the migration data channel. On the outgoing side of the migration, the credentials must be for a ‘client’ endpoint, while for the incoming side the credentials must be for a ‘server’ endpoint. Setting this will enable TLS for all migrations. The default is unset, resulting in unsecured migration at the QEMU level. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-hostname</span></code></dt> <dd>hostname of the target host for the migration. This is required when using x509 based TLS credentials and the migration URI does not already include a hostname. For example if using fd: or exec: based migration, the hostname must be provided so that the server’s x509 certificate identity can be validated. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code></dt> <dd>ID of the ‘authz’ object subclass that provides access control checking of the TLS x509 certificate distinguished name. This object is only resolved at time of use, so can be deleted and recreated on the fly while the migration server is active. If missing, it will default to denying access (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-bandwidth</span></code></dt> <dd>to set maximum speed for migration. maximum speed in bytes per second. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">downtime-limit</span></code></dt> <dd>set maximum tolerated downtime for migration. maximum downtime in milliseconds (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code></dt> <dd>The delay time (in ms) between two COLO checkpoints in periodic mode. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-incremental</span></code></dt> <dd>Affects how much storage is migrated when the block migration capability is enabled. When false, the entire storage backing chain is migrated into a flattened image at the destination; when true, only the active qcow2 layer is migrated and the destination must already have access to the same backing chain as was used on the source. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-channels</span></code></dt> <dd>Number of channels used to migrate data in parallel. This is the same number that the number of sockets used for migration. The default value is 2 (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">xbzrle-cache-size</span></code></dt> <dd>cache size to be used by XBZRLE migration. It needs to be a multiple of the target page size and a power of 2 (Since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-postcopy-bandwidth</span></code></dt> <dd>Background transfer bandwidth during postcopy. Defaults to 0 (unlimited). In bytes per second. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-cpu-throttle</span></code></dt> <dd>maximum cpu throttle percentage. Defaults to 99. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-compression</span></code></dt> <dd>Which compression method to use. Defaults to none. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zlib-level</span></code></dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 9, where 0 means no compression, 1 means the best compression speed, and 9 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zstd-level</span></code></dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 20, where 0 means no compression, 1 means the best compression speed, and 20 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-bitmap-mapping</span></code></dt> <dd>Maps block nodes and bitmaps on them to aliases for the purpose of dirty bitmap migration. Such aliases may for example be the corresponding names on the opposite site. The mapping must be one-to-one, but not necessarily complete: On the source, unmapped bitmaps and all bitmaps on unmapped nodes will be ignored. On the destination, encountering an unmapped alias in the incoming migration stream will result in a report, and all further bitmap migration data will then be discarded. Note that the destination does not know about bitmaps it does not receive, so there is no limitation or requirement regarding the number of bitmaps received, or how they are named, or on which nodes they are placed. By default (when this parameter has never been set), bitmap names are mapped to themselves. Nodes are mapped to their block device name if there is one, and to their node name otherwise. (Since 5.2)</dd> </dl> </div> <div class="section" id="qapidoc-1789"> <h4>Features<a class="headerlink" href="#qapidoc-1789" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-1790"> <h4>Since<a class="headerlink" href="#qapidoc-1790" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1795"> <h3><a class="toc-backref" href="#id262"><code class="docutils literal notranslate"><span class="pre">MigrateSetParameters</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1795" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1792"> <h4>Members<a class="headerlink" href="#qapidoc-1792" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">announce-initial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Initial delay (in milliseconds) before sending the first announce (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Maximum delay (in milliseconds) between packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-rounds</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Number of self-announce packets sent after migration (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-step</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Increase in delay (in milliseconds) between subsequent packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>compression level</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>compression thread count</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-wait-thread</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Controls behavior when all compression threads are currently busy. If true (default), wait for a free compression thread to become available; otherwise, send the page uncompressed. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">decompress-threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>decompression thread count</dd> <dt><code class="docutils literal notranslate"><span class="pre">throttle-trigger-threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The ratio of bytes_dirty_period and bytes_xfer_period to trigger throttling. It is expressed as percentage. The default value is 50. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-initial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Initial percentage of time guest cpus are throttled when migration auto-converge is activated. The default value is 20. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>throttle percentage increase each time auto-converge detects that migration is not making progress. The default value is 10. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-tailslow</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Make CPU throttling slower at tail stage At the tail stage of throttling, the Guest is very sensitive to CPU percentage while the <code class="docutils literal notranslate"><span class="pre">cpu-throttle</span></code> -increment is excessive usually at tail stage. If this parameter is true, we will compute the ideal CPU percentage used by the Guest, which may exactly make the dirty rate match the dirty rate threshold. Then we will choose a smaller throttle increment between the one specified by <code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code> and the one generated by ideal CPU percentage. Therefore, it is compatible to traditional throttling, meanwhile the throttle increment won’t be excessive at tail stage. The default value is false. (Since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (optional)</dt> <dd>ID of the ‘tls-creds’ object that provides credentials for establishing a TLS connection over the migration data channel. On the outgoing side of the migration, the credentials must be for a ‘client’ endpoint, while for the incoming side the credentials must be for a ‘server’ endpoint. Setting this to a non-empty string enables TLS for all migrations. An empty string means that QEMU will use plain text mode for migration, rather than TLS (Since 2.9) Previously (since 2.7), this was reported by omitting tls-creds instead.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-hostname</span></code>: <code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (optional)</dt> <dd>hostname of the target host for the migration. This is required when using x509 based TLS credentials and the migration URI does not already include a hostname. For example if using fd: or exec: based migration, the hostname must be provided so that the server’s x509 certificate identity can be validated. (Since 2.7) An empty string means that QEMU will use the hostname associated with the migration URI, if any. (Since 2.9) Previously (since 2.7), this was reported by omitting tls-hostname instead.</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-bandwidth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>to set maximum speed for migration. maximum speed in bytes per second. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">downtime-limit</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set maximum tolerated downtime for migration. maximum downtime in milliseconds (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the delay time between two COLO checkpoints. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-incremental</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Affects how much storage is migrated when the block migration capability is enabled. When false, the entire storage backing chain is migrated into a flattened image at the destination; when true, only the active qcow2 layer is migrated and the destination must already have access to the same backing chain as was used on the source. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-channels</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Number of channels used to migrate data in parallel. This is the same number that the number of sockets used for migration. The default value is 2 (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">xbzrle-cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>cache size to be used by XBZRLE migration. It needs to be a multiple of the target page size and a power of 2 (Since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-postcopy-bandwidth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Background transfer bandwidth during postcopy. Defaults to 0 (unlimited). In bytes per second. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-cpu-throttle</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum cpu throttle percentage. The default value is 99. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-compression</span></code>: <code class="docutils literal notranslate"><span class="pre">MultiFDCompression</span></code> (optional)</dt> <dd>Which compression method to use. Defaults to none. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zlib-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 9, where 0 means no compression, 1 means the best compression speed, and 9 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zstd-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 20, where 0 means no compression, 1 means the best compression speed, and 20 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-bitmap-mapping</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BitmapMigrationNodeAlias</span></code> (optional)</dt> <dd>Maps block nodes and bitmaps on them to aliases for the purpose of dirty bitmap migration. Such aliases may for example be the corresponding names on the opposite site. The mapping must be one-to-one, but not necessarily complete: On the source, unmapped bitmaps and all bitmaps on unmapped nodes will be ignored. On the destination, encountering an unmapped alias in the incoming migration stream will result in a report, and all further bitmap migration data will then be discarded. Note that the destination does not know about bitmaps it does not receive, so there is no limitation or requirement regarding the number of bitmaps received, or how they are named, or on which nodes they are placed. By default (when this parameter has never been set), bitmap names are mapped to themselves. Nodes are mapped to their block device name if there is one, and to their node name otherwise. (Since 5.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code>: <code class="docutils literal notranslate"><span class="pre">StrOrNull</span></code> (optional)</dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1793"> <h4>Features<a class="headerlink" href="#qapidoc-1793" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-1794"> <h4>Since<a class="headerlink" href="#qapidoc-1794" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1799"> <h3><a class="toc-backref" href="#id263"><code class="docutils literal notranslate"><span class="pre">migrate-set-parameters</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1799" title="Permalink to this headline">¶</a></h3> <p>Set various migration parameters.</p> <div class="section" id="qapidoc-1796"> <h4>Arguments<a class="headerlink" href="#qapidoc-1796" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">MigrateSetParameters</span></code></dl> </div> <div class="section" id="qapidoc-1797"> <h4>Since<a class="headerlink" href="#qapidoc-1797" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1798"> <h4>Example<a class="headerlink" href="#qapidoc-1798" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-set-parameters"</span> <span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"compress-level"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1803"> <h3><a class="toc-backref" href="#id264"><code class="docutils literal notranslate"><span class="pre">MigrationParameters</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1803" title="Permalink to this headline">¶</a></h3> <p>The optional members aren’t actually optional.</p> <div class="section" id="qapidoc-1800"> <h4>Members<a class="headerlink" href="#qapidoc-1800" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">announce-initial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Initial delay (in milliseconds) before sending the first announce (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Maximum delay (in milliseconds) between packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-rounds</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Number of self-announce packets sent after migration (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">announce-step</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Increase in delay (in milliseconds) between subsequent packets in the announcement (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>compression level</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>compression thread count</dd> <dt><code class="docutils literal notranslate"><span class="pre">compress-wait-thread</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Controls behavior when all compression threads are currently busy. If true (default), wait for a free compression thread to become available; otherwise, send the page uncompressed. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">decompress-threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>decompression thread count</dd> <dt><code class="docutils literal notranslate"><span class="pre">throttle-trigger-threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The ratio of bytes_dirty_period and bytes_xfer_period to trigger throttling. It is expressed as percentage. The default value is 50. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-initial</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Initial percentage of time guest cpus are throttled when migration auto-converge is activated. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>throttle percentage increase each time auto-converge detects that migration is not making progress. (Since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-throttle-tailslow</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Make CPU throttling slower at tail stage At the tail stage of throttling, the Guest is very sensitive to CPU percentage while the <code class="docutils literal notranslate"><span class="pre">cpu-throttle</span></code> -increment is excessive usually at tail stage. If this parameter is true, we will compute the ideal CPU percentage used by the Guest, which may exactly make the dirty rate match the dirty rate threshold. Then we will choose a smaller throttle increment between the one specified by <code class="docutils literal notranslate"><span class="pre">cpu-throttle-increment</span></code> and the one generated by ideal CPU percentage. Therefore, it is compatible to traditional throttling, meanwhile the throttle increment won’t be excessive at tail stage. The default value is false. (Since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the ‘tls-creds’ object that provides credentials for establishing a TLS connection over the migration data channel. On the outgoing side of the migration, the credentials must be for a ‘client’ endpoint, while for the incoming side the credentials must be for a ‘server’ endpoint. An empty string means that QEMU will use plain text mode for migration, rather than TLS (Since 2.7) Note: 2.8 reports this by omitting tls-creds instead.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-hostname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>hostname of the target host for the migration. This is required when using x509 based TLS credentials and the migration URI does not already include a hostname. For example if using fd: or exec: based migration, the hostname must be provided so that the server’s x509 certificate identity can be validated. (Since 2.7) An empty string means that QEMU will use the hostname associated with the migration URI, if any. (Since 2.9) Note: 2.8 reports this by omitting tls-hostname instead.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-authz</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>ID of the ‘authz’ object subclass that provides access control checking of the TLS x509 certificate distinguished name. (Since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-bandwidth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>to set maximum speed for migration. maximum speed in bytes per second. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">downtime-limit</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set maximum tolerated downtime for migration. maximum downtime in milliseconds (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the delay time between two COLO checkpoints. (Since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-incremental</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Affects how much storage is migrated when the block migration capability is enabled. When false, the entire storage backing chain is migrated into a flattened image at the destination; when true, only the active qcow2 layer is migrated and the destination must already have access to the same backing chain as was used on the source. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-channels</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Number of channels used to migrate data in parallel. This is the same number that the number of sockets used for migration. The default value is 2 (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">xbzrle-cache-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>cache size to be used by XBZRLE migration. It needs to be a multiple of the target page size and a power of 2 (Since 2.11)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-postcopy-bandwidth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Background transfer bandwidth during postcopy. Defaults to 0 (unlimited). In bytes per second. (Since 3.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-cpu-throttle</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum cpu throttle percentage. Defaults to 99. (Since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-compression</span></code>: <code class="docutils literal notranslate"><span class="pre">MultiFDCompression</span></code> (optional)</dt> <dd>Which compression method to use. Defaults to none. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zlib-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 9, where 0 means no compression, 1 means the best compression speed, and 9 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">multifd-zstd-level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Set the compression level to be used in live migration, the compression level is an integer between 0 and 20, where 0 means no compression, 1 means the best compression speed, and 20 means best compression ratio which will consume more CPU. Defaults to 1. (Since 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-bitmap-mapping</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">BitmapMigrationNodeAlias</span></code> (optional)</dt> <dd>Maps block nodes and bitmaps on them to aliases for the purpose of dirty bitmap migration. Such aliases may for example be the corresponding names on the opposite site. The mapping must be one-to-one, but not necessarily complete: On the source, unmapped bitmaps and all bitmaps on unmapped nodes will be ignored. On the destination, encountering an unmapped alias in the incoming migration stream will result in a report, and all further bitmap migration data will then be discarded. Note that the destination does not know about bitmaps it does not receive, so there is no limitation or requirement regarding the number of bitmaps received, or how they are named, or on which nodes they are placed. By default (when this parameter has never been set), bitmap names are mapped to themselves. Nodes are mapped to their block device name if there is one, and to their node name otherwise. (Since 5.2)</dd> </dl> </div> <div class="section" id="qapidoc-1801"> <h4>Features<a class="headerlink" href="#qapidoc-1801" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-checkpoint-delay</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-1802"> <h4>Since<a class="headerlink" href="#qapidoc-1802" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-1807"> <h3><a class="toc-backref" href="#id265"><code class="docutils literal notranslate"><span class="pre">query-migrate-parameters</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1807" title="Permalink to this headline">¶</a></h3> <p>Returns information about the current migration parameters</p> <div class="section" id="qapidoc-1804"> <h4>Returns<a class="headerlink" href="#qapidoc-1804" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">MigrationParameters</span></code></p> </div> <div class="section" id="qapidoc-1805"> <h4>Since<a class="headerlink" href="#qapidoc-1805" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1806"> <h4>Example<a class="headerlink" href="#qapidoc-1806" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-migrate-parameters"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"decompress-threads"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"cpu-throttle-increment"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> <span class="s2">"compress-threads"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span> <span class="s2">"compress-level"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"cpu-throttle-initial"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span> <span class="s2">"max-bandwidth"</span><span class="p">:</span> <span class="mi">33554432</span><span class="p">,</span> <span class="s2">"downtime-limit"</span><span class="p">:</span> <span class="mi">300</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1811"> <h3><a class="toc-backref" href="#id266"><code class="docutils literal notranslate"><span class="pre">client_migrate_info</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1811" title="Permalink to this headline">¶</a></h3> <p>Set migration information for remote display. This makes the server ask the client to automatically reconnect using the new parameters once migration finished successfully. Only implemented for SPICE.</p> <div class="section" id="qapidoc-1808"> <h4>Arguments<a class="headerlink" href="#qapidoc-1808" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>must be “spice”</dd> <dt><code class="docutils literal notranslate"><span class="pre">hostname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>migration target hostname</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>spice tcp port for plaintext channels</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-port</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>spice tcp port for tls-secured channels</dd> <dt><code class="docutils literal notranslate"><span class="pre">cert-subject</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>server certificate subject</dd> </dl> </div> <div class="section" id="qapidoc-1809"> <h4>Since<a class="headerlink" href="#qapidoc-1809" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1810"> <h4>Example<a class="headerlink" href="#qapidoc-1810" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"client_migrate_info"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"spice"</span><span class="p">,</span> <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"virt42.lab.kraxel.org"</span><span class="p">,</span> <span class="s2">"port"</span><span class="p">:</span> <span class="mi">1234</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1814"> <h3><a class="toc-backref" href="#id267"><code class="docutils literal notranslate"><span class="pre">migrate-start-postcopy</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1814" title="Permalink to this headline">¶</a></h3> <p>Followup to a migration command to switch the migration to postcopy mode. The postcopy-ram capability must be set on both source and destination before the original migration command.</p> <div class="section" id="qapidoc-1812"> <h4>Since<a class="headerlink" href="#qapidoc-1812" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> <div class="section" id="qapidoc-1813"> <h4>Example<a class="headerlink" href="#qapidoc-1813" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-start-postcopy"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1818"> <h3><a class="toc-backref" href="#id268"><code class="docutils literal notranslate"><span class="pre">MIGRATION</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1818" title="Permalink to this headline">¶</a></h3> <p>Emitted when a migration event happens</p> <div class="section" id="qapidoc-1815"> <h4>Arguments<a class="headerlink" href="#qapidoc-1815" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code></dt> <dd><code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code> describing the current migration status.</dd> </dl> </div> <div class="section" id="qapidoc-1816"> <h4>Since<a class="headerlink" href="#qapidoc-1816" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-1817"> <h4>Example<a class="headerlink" href="#qapidoc-1817" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span><span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1432121972</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">744001</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"MIGRATION"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"completed"</span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1822"> <h3><a class="toc-backref" href="#id269"><code class="docutils literal notranslate"><span class="pre">MIGRATION_PASS</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1822" title="Permalink to this headline">¶</a></h3> <p>Emitted from the source side of a migration at the start of each pass (when it syncs the dirty bitmap)</p> <div class="section" id="qapidoc-1819"> <h4>Arguments<a class="headerlink" href="#qapidoc-1819" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pass</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>An incrementing count (starting at 1 on the first pass)</dd> </dl> </div> <div class="section" id="qapidoc-1820"> <h4>Since<a class="headerlink" href="#qapidoc-1820" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-1821"> <h4>Example<a class="headerlink" href="#qapidoc-1821" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1449669631</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">239225</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"MIGRATION_PASS"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"pass"</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1825"> <h3><a class="toc-backref" href="#id270"><code class="docutils literal notranslate"><span class="pre">COLOMessage</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1825" title="Permalink to this headline">¶</a></h3> <p>The message transmission between Primary side and Secondary side.</p> <div class="section" id="qapidoc-1823"> <h4>Values<a class="headerlink" href="#qapidoc-1823" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">checkpoint-ready</span></code></dt> <dd>Secondary VM (SVM) is ready for checkpointing</dd> <dt><code class="docutils literal notranslate"><span class="pre">checkpoint-request</span></code></dt> <dd>Primary VM (PVM) tells SVM to prepare for checkpointing</dd> <dt><code class="docutils literal notranslate"><span class="pre">checkpoint-reply</span></code></dt> <dd>SVM gets PVM’s checkpoint request</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate-send</span></code></dt> <dd>VM’s state will be sent by PVM.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate-size</span></code></dt> <dd>The total size of VMstate.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate-received</span></code></dt> <dd>VM’s state has been received by SVM.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate-loaded</span></code></dt> <dd>VM’s state has been loaded by SVM.</dd> </dl> </div> <div class="section" id="qapidoc-1824"> <h4>Since<a class="headerlink" href="#qapidoc-1824" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-1828"> <h3><a class="toc-backref" href="#id271"><code class="docutils literal notranslate"><span class="pre">COLOMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1828" title="Permalink to this headline">¶</a></h3> <p>The COLO current mode.</p> <div class="section" id="qapidoc-1826"> <h4>Values<a class="headerlink" href="#qapidoc-1826" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>COLO is disabled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">primary</span></code></dt> <dd>COLO node in primary side.</dd> <dt><code class="docutils literal notranslate"><span class="pre">secondary</span></code></dt> <dd>COLO node in slave side.</dd> </dl> </div> <div class="section" id="qapidoc-1827"> <h4>Since<a class="headerlink" href="#qapidoc-1827" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-1831"> <h3><a class="toc-backref" href="#id272"><code class="docutils literal notranslate"><span class="pre">FailoverStatus</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1831" title="Permalink to this headline">¶</a></h3> <p>An enumeration of COLO failover status</p> <div class="section" id="qapidoc-1829"> <h4>Values<a class="headerlink" href="#qapidoc-1829" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>no failover has ever happened</dd> <dt><code class="docutils literal notranslate"><span class="pre">require</span></code></dt> <dd>got failover requirement but not handled</dd> <dt><code class="docutils literal notranslate"><span class="pre">active</span></code></dt> <dd>in the process of doing failover</dd> <dt><code class="docutils literal notranslate"><span class="pre">completed</span></code></dt> <dd>finish the process of failover</dd> <dt><code class="docutils literal notranslate"><span class="pre">relaunch</span></code></dt> <dd>restart the failover process, from ‘none’ -> ‘completed’ (Since 2.9)</dd> </dl> </div> <div class="section" id="qapidoc-1830"> <h4>Since<a class="headerlink" href="#qapidoc-1830" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-1835"> <h3><a class="toc-backref" href="#id273"><code class="docutils literal notranslate"><span class="pre">COLO_EXIT</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1835" title="Permalink to this headline">¶</a></h3> <p>Emitted when VM finishes COLO mode due to some errors happening or at the request of users.</p> <div class="section" id="qapidoc-1832"> <h4>Arguments<a class="headerlink" href="#qapidoc-1832" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">COLOMode</span></code></dt> <dd>report COLO mode when COLO exited.</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">COLOExitReason</span></code></dt> <dd>describes the reason for the COLO exit.</dd> </dl> </div> <div class="section" id="qapidoc-1833"> <h4>Since<a class="headerlink" href="#qapidoc-1833" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> <div class="section" id="qapidoc-1834"> <h4>Example<a class="headerlink" href="#qapidoc-1834" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">2032141960</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">417172</span><span class="p">},</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"COLO_EXIT"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"primary"</span><span class="p">,</span> <span class="s2">"reason"</span><span class="p">:</span> <span class="s2">"request"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1838"> <h3><a class="toc-backref" href="#id274"><code class="docutils literal notranslate"><span class="pre">COLOExitReason</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1838" title="Permalink to this headline">¶</a></h3> <p>The reason for a COLO exit.</p> <div class="section" id="qapidoc-1836"> <h4>Values<a class="headerlink" href="#qapidoc-1836" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>failover has never happened. This state does not occur in the COLO_EXIT event, and is only visible in the result of query-colo-status.</dd> <dt><code class="docutils literal notranslate"><span class="pre">request</span></code></dt> <dd>COLO exit is due to an external request.</dd> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code></dt> <dd>COLO exit is due to an internal error.</dd> <dt><code class="docutils literal notranslate"><span class="pre">processing</span></code></dt> <dd>COLO is currently handling a failover (since 4.0).</dd> </dl> </div> <div class="section" id="qapidoc-1837"> <h4>Since<a class="headerlink" href="#qapidoc-1837" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1842"> <h3><a class="toc-backref" href="#id275"><code class="docutils literal notranslate"><span class="pre">x-colo-lost-heartbeat</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1842" title="Permalink to this headline">¶</a></h3> <p>Tell qemu that heartbeat is lost, request it to do takeover procedures. If this command is sent to the PVM, the Primary side will exit COLO mode. If sent to the Secondary, the Secondary side will run failover work, then takes over server operation to become the service VM.</p> <div class="section" id="qapidoc-1839"> <h4>Features<a class="headerlink" href="#qapidoc-1839" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-1840"> <h4>Since<a class="headerlink" href="#qapidoc-1840" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-1841"> <h4>Example<a class="headerlink" href="#qapidoc-1841" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-colo-lost-heartbeat"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1847"> <h3><a class="toc-backref" href="#id276"><code class="docutils literal notranslate"><span class="pre">migrate_cancel</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1847" title="Permalink to this headline">¶</a></h3> <p>Cancel the current executing migration process.</p> <div class="section" id="qapidoc-1843"> <h4>Returns<a class="headerlink" href="#qapidoc-1843" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> </div> <div class="section" id="qapidoc-1844"> <h4>Notes<a class="headerlink" href="#qapidoc-1844" title="Permalink to this headline">¶</a></h4> <p>This command succeeds even if there is no migration process running.</p> </div> <div class="section" id="qapidoc-1845"> <h4>Since<a class="headerlink" href="#qapidoc-1845" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1846"> <h4>Example<a class="headerlink" href="#qapidoc-1846" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate_cancel"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1852"> <h3><a class="toc-backref" href="#id277"><code class="docutils literal notranslate"><span class="pre">migrate-continue</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1852" title="Permalink to this headline">¶</a></h3> <p>Continue migration when it’s in a paused state.</p> <div class="section" id="qapidoc-1848"> <h4>Arguments<a class="headerlink" href="#qapidoc-1848" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">MigrationStatus</span></code></dt> <dd>The state the migration is currently expected to be in</dd> </dl> </div> <div class="section" id="qapidoc-1849"> <h4>Returns<a class="headerlink" href="#qapidoc-1849" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> </div> <div class="section" id="qapidoc-1850"> <h4>Since<a class="headerlink" href="#qapidoc-1850" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> <div class="section" id="qapidoc-1851"> <h4>Example<a class="headerlink" href="#qapidoc-1851" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-continue"</span> <span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"pre-switchover"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1858"> <h3><a class="toc-backref" href="#id278"><code class="docutils literal notranslate"><span class="pre">migrate</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1858" title="Permalink to this headline">¶</a></h3> <p>Migrates the current running guest to another Virtual Machine.</p> <div class="section" id="qapidoc-1853"> <h4>Arguments<a class="headerlink" href="#qapidoc-1853" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">uri</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the Uniform Resource Identifier of the destination VM</dd> <dt><code class="docutils literal notranslate"><span class="pre">blk</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>do block migration (full disk copy)</dd> <dt><code class="docutils literal notranslate"><span class="pre">inc</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>incremental disk copy migration</dd> <dt><code class="docutils literal notranslate"><span class="pre">detach</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>this argument exists only for compatibility reasons and is ignored by QEMU</dd> <dt><code class="docutils literal notranslate"><span class="pre">resume</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>resume one paused migration, default “off”. (since 3.0)</dd> </dl> </div> <div class="section" id="qapidoc-1854"> <h4>Returns<a class="headerlink" href="#qapidoc-1854" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> </div> <div class="section" id="qapidoc-1855"> <h4>Since<a class="headerlink" href="#qapidoc-1855" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-1856"> <h4>Notes<a class="headerlink" href="#qapidoc-1856" title="Permalink to this headline">¶</a></h4> <ol class="arabic simple"> <li>The ‘query-migrate’ command should be used to check migration’s progress and final result (this information is provided by the ‘status’ member)</li> <li>All boolean arguments default to false</li> <li>The user Monitor’s “detach” argument is invalid in QMP and should not be used</li> </ol> </div> <div class="section" id="qapidoc-1857"> <h4>Example<a class="headerlink" href="#qapidoc-1857" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"uri"</span><span class="p">:</span> <span class="s2">"tcp:0:4446"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1864"> <h3><a class="toc-backref" href="#id279"><code class="docutils literal notranslate"><span class="pre">migrate-incoming</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1864" title="Permalink to this headline">¶</a></h3> <p>Start an incoming migration, the qemu must have been started with -incoming defer</p> <div class="section" id="qapidoc-1859"> <h4>Arguments<a class="headerlink" href="#qapidoc-1859" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">uri</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The Uniform Resource Identifier identifying the source or address to listen on</dd> </dl> </div> <div class="section" id="qapidoc-1860"> <h4>Returns<a class="headerlink" href="#qapidoc-1860" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> </div> <div class="section" id="qapidoc-1861"> <h4>Since<a class="headerlink" href="#qapidoc-1861" title="Permalink to this headline">¶</a></h4> <p>2.3</p> </div> <div class="section" id="qapidoc-1862"> <h4>Notes<a class="headerlink" href="#qapidoc-1862" title="Permalink to this headline">¶</a></h4> <ol class="arabic simple"> <li>It’s a bad idea to use a string for the uri, but it needs to stay compatible with -incoming and the format of the uri is already exposed above libvirt.</li> <li>QEMU must be started with -incoming defer to allow migrate-incoming to be used.</li> <li>The uri format is the same as for -incoming</li> </ol> </div> <div class="section" id="qapidoc-1863"> <h4>Example<a class="headerlink" href="#qapidoc-1863" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-incoming"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"uri"</span><span class="p">:</span> <span class="s2">"tcp::4446"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1869"> <h3><a class="toc-backref" href="#id280"><code class="docutils literal notranslate"><span class="pre">xen-save-devices-state</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1869" title="Permalink to this headline">¶</a></h3> <p>Save the state of all devices to file. The RAM and the block devices of the VM are not saved by this command.</p> <div class="section" id="qapidoc-1865"> <h4>Arguments<a class="headerlink" href="#qapidoc-1865" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the file to save the state of the devices to as binary data. See xen-save-devices-state.txt for a description of the binary format.</dd> <dt><code class="docutils literal notranslate"><span class="pre">live</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Optional argument to ask QEMU to treat this command as part of a live migration. Default to true. (since 2.11)</dd> </dl> </div> <div class="section" id="qapidoc-1866"> <h4>Returns<a class="headerlink" href="#qapidoc-1866" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-1867"> <h4>Since<a class="headerlink" href="#qapidoc-1867" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> <div class="section" id="qapidoc-1868"> <h4>Example<a class="headerlink" href="#qapidoc-1868" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"xen-save-devices-state"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/save"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1874"> <h3><a class="toc-backref" href="#id281"><code class="docutils literal notranslate"><span class="pre">xen-set-global-dirty-log</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1874" title="Permalink to this headline">¶</a></h3> <p>Enable or disable the global dirty log mode.</p> <div class="section" id="qapidoc-1870"> <h4>Arguments<a class="headerlink" href="#qapidoc-1870" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true to enable, false to disable.</dd> </dl> </div> <div class="section" id="qapidoc-1871"> <h4>Returns<a class="headerlink" href="#qapidoc-1871" title="Permalink to this headline">¶</a></h4> <p>nothing</p> </div> <div class="section" id="qapidoc-1872"> <h4>Since<a class="headerlink" href="#qapidoc-1872" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> <div class="section" id="qapidoc-1873"> <h4>Example<a class="headerlink" href="#qapidoc-1873" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"xen-set-global-dirty-log"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enable"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1878"> <h3><a class="toc-backref" href="#id282"><code class="docutils literal notranslate"><span class="pre">xen-load-devices-state</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1878" title="Permalink to this headline">¶</a></h3> <p>Load the state of all devices from file. The RAM and the block devices of the VM are not loaded by this command.</p> <div class="section" id="qapidoc-1875"> <h4>Arguments<a class="headerlink" href="#qapidoc-1875" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the file to load the state of the devices from as binary data. See xen-save-devices-state.txt for a description of the binary format.</dd> </dl> </div> <div class="section" id="qapidoc-1876"> <h4>Since<a class="headerlink" href="#qapidoc-1876" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> <div class="section" id="qapidoc-1877"> <h4>Example<a class="headerlink" href="#qapidoc-1877" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"xen-load-devices-state"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/resume"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1884"> <h3><a class="toc-backref" href="#id283"><code class="docutils literal notranslate"><span class="pre">xen-set-replication</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1884" title="Permalink to this headline">¶</a></h3> <p>Enable or disable replication.</p> <div class="section" id="qapidoc-1879"> <h4>Arguments<a class="headerlink" href="#qapidoc-1879" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true to enable, false to disable.</dd> <dt><code class="docutils literal notranslate"><span class="pre">primary</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true for primary or false for secondary.</dd> <dt><code class="docutils literal notranslate"><span class="pre">failover</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>true to do failover, false to stop. but cannot be specified if ‘enable’ is true. default value is false.</dd> </dl> </div> <div class="section" id="qapidoc-1880"> <h4>Returns<a class="headerlink" href="#qapidoc-1880" title="Permalink to this headline">¶</a></h4> <p>nothing.</p> </div> <div class="section" id="qapidoc-1881"> <h4>Example<a class="headerlink" href="#qapidoc-1881" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"xen-set-replication"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"enable"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"primary"</span><span class="p">:</span> <span class="n">false</span><span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1882"> <h4>Since<a class="headerlink" href="#qapidoc-1882" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> <div class="section" id="qapidoc-1883"> <h4>If<a class="headerlink" href="#qapidoc-1883" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-1888"> <h3><a class="toc-backref" href="#id284"><code class="docutils literal notranslate"><span class="pre">ReplicationStatus</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1888" title="Permalink to this headline">¶</a></h3> <p>The result format for ‘query-xen-replication-status’.</p> <div class="section" id="qapidoc-1885"> <h4>Members<a class="headerlink" href="#qapidoc-1885" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">error</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if an error happened, false if replication is normal.</dd> <dt><code class="docutils literal notranslate"><span class="pre">desc</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the human readable error description string, when <code class="docutils literal notranslate"><span class="pre">error</span></code> is ‘true’.</dd> </dl> </div> <div class="section" id="qapidoc-1886"> <h4>Since<a class="headerlink" href="#qapidoc-1886" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> <div class="section" id="qapidoc-1887"> <h4>If<a class="headerlink" href="#qapidoc-1887" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-1893"> <h3><a class="toc-backref" href="#id285"><code class="docutils literal notranslate"><span class="pre">query-xen-replication-status</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1893" title="Permalink to this headline">¶</a></h3> <p>Query replication status while the vm is running.</p> <div class="section" id="qapidoc-1889"> <h4>Returns<a class="headerlink" href="#qapidoc-1889" title="Permalink to this headline">¶</a></h4> <p>A <code class="docutils literal notranslate"><span class="pre">ReplicationResult</span></code> object showing the status.</p> </div> <div class="section" id="qapidoc-1890"> <h4>Example<a class="headerlink" href="#qapidoc-1890" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-xen-replication-status"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"error"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1891"> <h4>Since<a class="headerlink" href="#qapidoc-1891" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> <div class="section" id="qapidoc-1892"> <h4>If<a class="headerlink" href="#qapidoc-1892" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-1898"> <h3><a class="toc-backref" href="#id286"><code class="docutils literal notranslate"><span class="pre">xen-colo-do-checkpoint</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1898" title="Permalink to this headline">¶</a></h3> <p>Xen uses this command to notify replication to trigger a checkpoint.</p> <div class="section" id="qapidoc-1894"> <h4>Returns<a class="headerlink" href="#qapidoc-1894" title="Permalink to this headline">¶</a></h4> <p>nothing.</p> </div> <div class="section" id="qapidoc-1895"> <h4>Example<a class="headerlink" href="#qapidoc-1895" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"xen-colo-do-checkpoint"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1896"> <h4>Since<a class="headerlink" href="#qapidoc-1896" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> <div class="section" id="qapidoc-1897"> <h4>If<a class="headerlink" href="#qapidoc-1897" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_REPLICATION</span></code></p> </div> </div> <div class="section" id="qapidoc-1901"> <h3><a class="toc-backref" href="#id287"><code class="docutils literal notranslate"><span class="pre">COLOStatus</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1901" title="Permalink to this headline">¶</a></h3> <p>The result format for ‘query-colo-status’.</p> <div class="section" id="qapidoc-1899"> <h4>Members<a class="headerlink" href="#qapidoc-1899" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">COLOMode</span></code></dt> <dd>COLO running mode. If COLO is running, this field will return ‘primary’ or ‘secondary’.</dd> <dt><code class="docutils literal notranslate"><span class="pre">last-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">COLOMode</span></code></dt> <dd>COLO last running mode. If COLO is running, this field will return same like mode field, after failover we can use this field to get last colo mode. (since 4.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reason</span></code>: <code class="docutils literal notranslate"><span class="pre">COLOExitReason</span></code></dt> <dd>describes the reason for the COLO exit.</dd> </dl> </div> <div class="section" id="qapidoc-1900"> <h4>Since<a class="headerlink" href="#qapidoc-1900" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1905"> <h3><a class="toc-backref" href="#id288"><code class="docutils literal notranslate"><span class="pre">query-colo-status</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1905" title="Permalink to this headline">¶</a></h3> <p>Query COLO status while the vm is running.</p> <div class="section" id="qapidoc-1902"> <h4>Returns<a class="headerlink" href="#qapidoc-1902" title="Permalink to this headline">¶</a></h4> <p>A <code class="docutils literal notranslate"><span class="pre">COLOStatus</span></code> object showing the status.</p> </div> <div class="section" id="qapidoc-1903"> <h4>Example<a class="headerlink" href="#qapidoc-1903" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-colo-status"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"primary"</span><span class="p">,</span> <span class="s2">"reason"</span><span class="p">:</span> <span class="s2">"request"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1904"> <h4>Since<a class="headerlink" href="#qapidoc-1904" title="Permalink to this headline">¶</a></h4> <p>3.1</p> </div> </div> <div class="section" id="qapidoc-1910"> <h3><a class="toc-backref" href="#id289"><code class="docutils literal notranslate"><span class="pre">migrate-recover</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1910" title="Permalink to this headline">¶</a></h3> <p>Provide a recovery migration stream URI.</p> <div class="section" id="qapidoc-1906"> <h4>Arguments<a class="headerlink" href="#qapidoc-1906" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">uri</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the URI to be used for the recovery of migration stream.</dd> </dl> </div> <div class="section" id="qapidoc-1907"> <h4>Returns<a class="headerlink" href="#qapidoc-1907" title="Permalink to this headline">¶</a></h4> <p>nothing.</p> </div> <div class="section" id="qapidoc-1908"> <h4>Example<a class="headerlink" href="#qapidoc-1908" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-recover"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"uri"</span><span class="p">:</span> <span class="s2">"tcp:192.168.1.200:12345"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1909"> <h4>Since<a class="headerlink" href="#qapidoc-1909" title="Permalink to this headline">¶</a></h4> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-1914"> <h3><a class="toc-backref" href="#id290"><code class="docutils literal notranslate"><span class="pre">migrate-pause</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1914" title="Permalink to this headline">¶</a></h3> <p>Pause a migration. Currently it only supports postcopy.</p> <div class="section" id="qapidoc-1911"> <h4>Returns<a class="headerlink" href="#qapidoc-1911" title="Permalink to this headline">¶</a></h4> <p>nothing.</p> </div> <div class="section" id="qapidoc-1912"> <h4>Example<a class="headerlink" href="#qapidoc-1912" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"migrate-pause"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1913"> <h4>Since<a class="headerlink" href="#qapidoc-1913" title="Permalink to this headline">¶</a></h4> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-1918"> <h3><a class="toc-backref" href="#id291"><code class="docutils literal notranslate"><span class="pre">UNPLUG_PRIMARY</span></code> (Event)</a><a class="headerlink" href="#qapidoc-1918" title="Permalink to this headline">¶</a></h3> <p>Emitted from source side of a migration when migration state is WAIT_UNPLUG. Device was unplugged by guest operating system. Device resources in QEMU are kept on standby to be able to re-plug it in case of migration failure.</p> <div class="section" id="qapidoc-1915"> <h4>Arguments<a class="headerlink" href="#qapidoc-1915" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>QEMU device id of the unplugged device</dd> </dl> </div> <div class="section" id="qapidoc-1916"> <h4>Since<a class="headerlink" href="#qapidoc-1916" title="Permalink to this headline">¶</a></h4> <p>4.2</p> </div> <div class="section" id="qapidoc-1917"> <h4>Example<a class="headerlink" href="#qapidoc-1917" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"UNPLUG_PRIMARY"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"device-id"</span><span class="p">:</span> <span class="s2">"hostdev0"</span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1921"> <h3><a class="toc-backref" href="#id292"><code class="docutils literal notranslate"><span class="pre">DirtyRateVcpu</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1921" title="Permalink to this headline">¶</a></h3> <p>Dirty rate of vcpu.</p> <div class="section" id="qapidoc-1919"> <h4>Members<a class="headerlink" href="#qapidoc-1919" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>vcpu index.</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>dirty rate.</dd> </dl> </div> <div class="section" id="qapidoc-1920"> <h4>Since<a class="headerlink" href="#qapidoc-1920" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-1924"> <h3><a class="toc-backref" href="#id293"><code class="docutils literal notranslate"><span class="pre">DirtyRateStatus</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1924" title="Permalink to this headline">¶</a></h3> <p>An enumeration of dirtyrate status.</p> <div class="section" id="qapidoc-1922"> <h4>Values<a class="headerlink" href="#qapidoc-1922" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstarted</span></code></dt> <dd>the dirtyrate thread has not been started.</dd> <dt><code class="docutils literal notranslate"><span class="pre">measuring</span></code></dt> <dd>the dirtyrate thread is measuring.</dd> <dt><code class="docutils literal notranslate"><span class="pre">measured</span></code></dt> <dd>the dirtyrate thread has measured and results are available.</dd> </dl> </div> <div class="section" id="qapidoc-1923"> <h4>Since<a class="headerlink" href="#qapidoc-1923" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1927"> <h3><a class="toc-backref" href="#id294"><code class="docutils literal notranslate"><span class="pre">DirtyRateMeasureMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1927" title="Permalink to this headline">¶</a></h3> <p>An enumeration of mode of measuring dirtyrate.</p> <div class="section" id="qapidoc-1925"> <h4>Values<a class="headerlink" href="#qapidoc-1925" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">page-sampling</span></code></dt> <dd>calculate dirtyrate by sampling pages.</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-ring</span></code></dt> <dd>calculate dirtyrate by dirty ring.</dd> <dt><code class="docutils literal notranslate"><span class="pre">dirty-bitmap</span></code></dt> <dd>calculate dirtyrate by dirty bitmap.</dd> </dl> </div> <div class="section" id="qapidoc-1926"> <h4>Since<a class="headerlink" href="#qapidoc-1926" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-1930"> <h3><a class="toc-backref" href="#id295"><code class="docutils literal notranslate"><span class="pre">DirtyRateInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1930" title="Permalink to this headline">¶</a></h3> <p>Information about current dirty page rate of vm.</p> <div class="section" id="qapidoc-1928"> <h4>Members<a class="headerlink" href="#qapidoc-1928" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dirty-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>an estimate of the dirty page rate of the VM in units of MB/s, present only when estimating the rate has completed.</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">DirtyRateStatus</span></code></dt> <dd>status containing dirtyrate query status includes ‘unstarted’ or ‘measuring’ or ‘measured’</dd> <dt><code class="docutils literal notranslate"><span class="pre">start-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>start time in units of second for calculation</dd> <dt><code class="docutils literal notranslate"><span class="pre">calc-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>time in units of second for sample dirty pages</dd> <dt><code class="docutils literal notranslate"><span class="pre">sample-pages</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>page count per GB for sample dirty pages the default value is 512 (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">DirtyRateMeasureMode</span></code></dt> <dd>mode containing method of calculate dirtyrate includes ‘page-sampling’ and ‘dirty-ring’ (Since 6.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">vcpu-dirty-rate</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">DirtyRateVcpu</span></code> (optional)</dt> <dd>dirtyrate for each vcpu if dirty-ring mode specified (Since 6.2)</dd> </dl> </div> <div class="section" id="qapidoc-1929"> <h4>Since<a class="headerlink" href="#qapidoc-1929" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1934"> <h3><a class="toc-backref" href="#id296"><code class="docutils literal notranslate"><span class="pre">calc-dirty-rate</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1934" title="Permalink to this headline">¶</a></h3> <p>start calculating dirty page rate for vm</p> <div class="section" id="qapidoc-1931"> <h4>Arguments<a class="headerlink" href="#qapidoc-1931" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">calc-time</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>time in units of second for sample dirty pages</dd> <dt><code class="docutils literal notranslate"><span class="pre">sample-pages</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>page count per GB for sample dirty pages the default value is 512 (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">DirtyRateMeasureMode</span></code> (optional)</dt> <dd>mechanism of calculating dirtyrate includes ‘page-sampling’ and ‘dirty-ring’ (Since 6.1)</dd> </dl> </div> <div class="section" id="qapidoc-1932"> <h4>Since<a class="headerlink" href="#qapidoc-1932" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-1933"> <h4>Example<a class="headerlink" href="#qapidoc-1933" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"command"</span><span class="p">:</span> <span class="s2">"calc-dirty-rate"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"calc-time"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">'sample-pages'</span><span class="p">:</span> <span class="mi">512</span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-1936"> <h3><a class="toc-backref" href="#id297"><code class="docutils literal notranslate"><span class="pre">query-dirty-rate</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1936" title="Permalink to this headline">¶</a></h3> <p>query dirty page rate in units of MB/s for vm</p> <div class="section" id="qapidoc-1935"> <h4>Since<a class="headerlink" href="#qapidoc-1935" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-1942"> <h3><a class="toc-backref" href="#id298"><code class="docutils literal notranslate"><span class="pre">snapshot-save</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1942" title="Permalink to this headline">¶</a></h3> <p>Save a VM snapshot</p> <div class="section" id="qapidoc-1937"> <h4>Arguments<a class="headerlink" href="#qapidoc-1937" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>identifier for the newly created job</dd> <dt><code class="docutils literal notranslate"><span class="pre">tag</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the snapshot to create</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>block device node name to save vmstate to</dd> <dt><code class="docutils literal notranslate"><span class="pre">devices</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>list of block device node names to save a snapshot to</dd> </dl> </div> <div class="section" id="qapidoc-1938"> <p>Applications should not assume that the snapshot save is complete when this command returns. The job commands / events must be used to determine completion and to fetch details of any errors that arise.</p> <p>Note that execution of the guest CPUs may be stopped during the time it takes to save the snapshot. A future version of QEMU may ensure CPUs are executing continuously.</p> <p>It is strongly recommended that <code class="docutils literal notranslate"><span class="pre">devices</span></code> contain all writable block device nodes if a consistent snapshot is required.</p> <p>If <code class="docutils literal notranslate"><span class="pre">tag</span></code> already exists, an error will be reported</p> </div> <div class="section" id="qapidoc-1939"> <h4>Returns<a class="headerlink" href="#qapidoc-1939" title="Permalink to this headline">¶</a></h4> <p>nothing</p> </div> <div class="section" id="qapidoc-1940"> <h4>Example<a class="headerlink" href="#qapidoc-1940" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"snapshot-save"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"job-id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">,</span> <span class="s2">"tag"</span><span class="p">:</span> <span class="s2">"my-snap"</span><span class="p">,</span> <span class="s2">"vmstate"</span><span class="p">:</span> <span class="s2">"disk0"</span><span class="p">,</span> <span class="s2">"devices"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"disk0"</span><span class="p">,</span> <span class="s2">"disk1"</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"created"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"running"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"STOP"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RESUME"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"waiting"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"pending"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}}</span> <span class="o">-></span> <span class="p">{</span><span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-jobs"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"current-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"total-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"snapshot-save"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapsave0"</span><span class="p">}]}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1941"> <h4>Since<a class="headerlink" href="#qapidoc-1941" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1948"> <h3><a class="toc-backref" href="#id299"><code class="docutils literal notranslate"><span class="pre">snapshot-load</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1948" title="Permalink to this headline">¶</a></h3> <p>Load a VM snapshot</p> <div class="section" id="qapidoc-1943"> <h4>Arguments<a class="headerlink" href="#qapidoc-1943" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>identifier for the newly created job</dd> <dt><code class="docutils literal notranslate"><span class="pre">tag</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the snapshot to load.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vmstate</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>block device node name to load vmstate from</dd> <dt><code class="docutils literal notranslate"><span class="pre">devices</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>list of block device node names to load a snapshot from</dd> </dl> </div> <div class="section" id="qapidoc-1944"> <p>Applications should not assume that the snapshot load is complete when this command returns. The job commands / events must be used to determine completion and to fetch details of any errors that arise.</p> <p>Note that execution of the guest CPUs will be stopped during the time it takes to load the snapshot.</p> <p>It is strongly recommended that <code class="docutils literal notranslate"><span class="pre">devices</span></code> contain all writable block device nodes that can have changed since the original <code class="docutils literal notranslate"><span class="pre">snapshot-save</span></code> command execution.</p> </div> <div class="section" id="qapidoc-1945"> <h4>Returns<a class="headerlink" href="#qapidoc-1945" title="Permalink to this headline">¶</a></h4> <p>nothing</p> </div> <div class="section" id="qapidoc-1946"> <h4>Example<a class="headerlink" href="#qapidoc-1946" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"snapshot-load"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"job-id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">,</span> <span class="s2">"tag"</span><span class="p">:</span> <span class="s2">"my-snap"</span><span class="p">,</span> <span class="s2">"vmstate"</span><span class="p">:</span> <span class="s2">"disk0"</span><span class="p">,</span> <span class="s2">"devices"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"disk0"</span><span class="p">,</span> <span class="s2">"disk1"</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"created"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"running"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"STOP"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RESUME"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"waiting"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"pending"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}}</span> <span class="o">-></span> <span class="p">{</span><span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-jobs"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"current-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"total-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"snapshot-load"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapload0"</span><span class="p">}]}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1947"> <h4>Since<a class="headerlink" href="#qapidoc-1947" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-1954"> <h3><a class="toc-backref" href="#id300"><code class="docutils literal notranslate"><span class="pre">snapshot-delete</span></code> (Command)</a><a class="headerlink" href="#qapidoc-1954" title="Permalink to this headline">¶</a></h3> <p>Delete a VM snapshot</p> <div class="section" id="qapidoc-1949"> <h4>Arguments<a class="headerlink" href="#qapidoc-1949" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">job-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>identifier for the newly created job</dd> <dt><code class="docutils literal notranslate"><span class="pre">tag</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the snapshot to delete.</dd> <dt><code class="docutils literal notranslate"><span class="pre">devices</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>list of block device node names to delete a snapshot from</dd> </dl> </div> <div class="section" id="qapidoc-1950"> Applications should not assume that the snapshot delete is complete when this command returns. The job commands / events must be used to determine completion and to fetch details of any errors that arise.</div> <div class="section" id="qapidoc-1951"> <h4>Returns<a class="headerlink" href="#qapidoc-1951" title="Permalink to this headline">¶</a></h4> <p>nothing</p> </div> <div class="section" id="qapidoc-1952"> <h4>Example<a class="headerlink" href="#qapidoc-1952" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"snapshot-delete"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"job-id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">,</span> <span class="s2">"tag"</span><span class="p">:</span> <span class="s2">"my-snap"</span><span class="p">,</span> <span class="s2">"devices"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"disk0"</span><span class="p">,</span> <span class="s2">"disk1"</span><span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"created"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"running"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"waiting"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"pending"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"event"</span><span class="p">:</span> <span class="s2">"JOB_STATUS_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}}</span> <span class="o">-></span> <span class="p">{</span><span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-jobs"</span><span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"current-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"concluded"</span><span class="p">,</span> <span class="s2">"total-progress"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"snapshot-delete"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"snapdelete0"</span><span class="p">}]}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-1953"> <h4>Since<a class="headerlink" href="#qapidoc-1953" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> </div> <div class="section" id="qapidoc-1955"> <h2><a class="toc-backref" href="#id301">Transactions</a><a class="headerlink" href="#qapidoc-1955" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-1957"> <h3><a class="toc-backref" href="#id302"><code class="docutils literal notranslate"><span class="pre">Abort</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1957" title="Permalink to this headline">¶</a></h3> <p>This action can be used to test transaction failure.</p> <div class="section" id="qapidoc-1956"> <h4>Since<a class="headerlink" href="#qapidoc-1956" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-1960"> <h3><a class="toc-backref" href="#id303"><code class="docutils literal notranslate"><span class="pre">ActionCompletionMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1960" title="Permalink to this headline">¶</a></h3> <p>An enumeration of Transactional completion modes.</p> <div class="section" id="qapidoc-1958"> <h4>Values<a class="headerlink" href="#qapidoc-1958" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">individual</span></code></dt> <dd>Do not attempt to cancel any other Actions if any Actions fail after the Transaction request succeeds. All Actions that can complete successfully will do so without waiting on others. This is the default.</dd> <dt><code class="docutils literal notranslate"><span class="pre">grouped</span></code></dt> <dd>If any Action fails after the Transaction succeeds, cancel all Actions. Actions do not complete until all Actions are ready to complete. May be rejected by Actions that do not support this completion mode.</dd> </dl> </div> <div class="section" id="qapidoc-1959"> <h4>Since<a class="headerlink" href="#qapidoc-1959" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-1964"> <h3><a class="toc-backref" href="#id304"><code class="docutils literal notranslate"><span class="pre">TransactionActionKind</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-1964" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1961"> <h4>Values<a class="headerlink" href="#qapidoc-1961" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">abort</span></code></dt> <dd>Since 1.6</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-add</span></code></dt> <dd>Since 2.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-remove</span></code></dt> <dd>Since 4.2</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-clear</span></code></dt> <dd>Since 2.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-enable</span></code></dt> <dd>Since 4.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-disable</span></code></dt> <dd>Since 4.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-dirty-bitmap-merge</span></code></dt> <dd>Since 4.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">blockdev-backup</span></code></dt> <dd>Since 2.3</dd> <dt><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot</span></code></dt> <dd>Since 2.5</dd> <dt><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot-internal-sync</span></code></dt> <dd>Since 1.7</dd> <dt><code class="docutils literal notranslate"><span class="pre">blockdev-snapshot-sync</span></code></dt> <dd>since 1.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">drive-backup</span></code></dt> <dd>Since 1.6</dd> </dl> </div> <div class="section" id="qapidoc-1962"> <h4>Features<a class="headerlink" href="#qapidoc-1962" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">drive-backup</span></code> is deprecated. Use member <code class="docutils literal notranslate"><span class="pre">blockdev-backup</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-1963"> <h4>Since<a class="headerlink" href="#qapidoc-1963" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-1967"> <h3><a class="toc-backref" href="#id305"><code class="docutils literal notranslate"><span class="pre">AbortWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1967" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1965"> <h4>Members<a class="headerlink" href="#qapidoc-1965" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">Abort</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1966"> <h4>Since<a class="headerlink" href="#qapidoc-1966" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-1970"> <h3><a class="toc-backref" href="#id306"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAddWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1970" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1968"> <h4>Members<a class="headerlink" href="#qapidoc-1968" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAdd</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1969"> <h4>Since<a class="headerlink" href="#qapidoc-1969" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-1973"> <h3><a class="toc-backref" href="#id307"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1973" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1971"> <h4>Members<a class="headerlink" href="#qapidoc-1971" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmap</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1972"> <h4>Since<a class="headerlink" href="#qapidoc-1972" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-1976"> <h3><a class="toc-backref" href="#id308"><code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMergeWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1976" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1974"> <h4>Members<a class="headerlink" href="#qapidoc-1974" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMerge</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1975"> <h4>Since<a class="headerlink" href="#qapidoc-1975" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-1979"> <h3><a class="toc-backref" href="#id309"><code class="docutils literal notranslate"><span class="pre">BlockdevBackupWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1979" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1977"> <h4>Members<a class="headerlink" href="#qapidoc-1977" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevBackup</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1978"> <h4>Since<a class="headerlink" href="#qapidoc-1978" title="Permalink to this headline">¶</a></h4> <p>2.3</p> </div> </div> <div class="section" id="qapidoc-1982"> <h3><a class="toc-backref" href="#id310"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1982" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1980"> <h4>Members<a class="headerlink" href="#qapidoc-1980" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshot</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1981"> <h4>Since<a class="headerlink" href="#qapidoc-1981" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-1985"> <h3><a class="toc-backref" href="#id311"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternalWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1985" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1983"> <h4>Members<a class="headerlink" href="#qapidoc-1983" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternal</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1984"> <h4>Since<a class="headerlink" href="#qapidoc-1984" title="Permalink to this headline">¶</a></h4> <p>1.7</p> </div> </div> <div class="section" id="qapidoc-1988"> <h3><a class="toc-backref" href="#id312"><code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSyncWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1988" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1986"> <h4>Members<a class="headerlink" href="#qapidoc-1986" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSync</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1987"> <h4>Since<a class="headerlink" href="#qapidoc-1987" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-1991"> <h3><a class="toc-backref" href="#id313"><code class="docutils literal notranslate"><span class="pre">DriveBackupWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1991" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-1989"> <h4>Members<a class="headerlink" href="#qapidoc-1989" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">DriveBackup</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-1990"> <h4>Since<a class="headerlink" href="#qapidoc-1990" title="Permalink to this headline">¶</a></h4> <p>1.6</p> </div> </div> <div class="section" id="qapidoc-1994"> <h3><a class="toc-backref" href="#id314"><code class="docutils literal notranslate"><span class="pre">TransactionAction</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1994" title="Permalink to this headline">¶</a></h3> <p>A discriminated record of operations that can be performed with <code class="docutils literal notranslate"><span class="pre">transaction</span></code>.</p> <div class="section" id="qapidoc-1992"> <h4>Members<a class="headerlink" href="#qapidoc-1992" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">TransactionActionKind</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AbortWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"abort"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapAddWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-add"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-remove"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-clear"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-enable"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-disable"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockDirtyBitmapMergeWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-dirty-bitmap-merge"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevBackupWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"blockdev-backup"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"blockdev-snapshot"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotInternalWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"blockdev-snapshot-internal-sync"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">BlockdevSnapshotSyncWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"blockdev-snapshot-sync"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">DriveBackupWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"drive-backup"</span></code></dl> </div> <div class="section" id="qapidoc-1993"> <h4>Since<a class="headerlink" href="#qapidoc-1993" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-1997"> <h3><a class="toc-backref" href="#id315"><code class="docutils literal notranslate"><span class="pre">TransactionProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-1997" title="Permalink to this headline">¶</a></h3> <p>Optional arguments to modify the behavior of a Transaction.</p> <div class="section" id="qapidoc-1995"> <h4>Members<a class="headerlink" href="#qapidoc-1995" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">completion-mode</span></code>: <code class="docutils literal notranslate"><span class="pre">ActionCompletionMode</span></code> (optional)</dt> <dd>Controls how jobs launched asynchronously by Actions will complete or fail as a group. See <code class="docutils literal notranslate"><span class="pre">ActionCompletionMode</span></code> for details.</dd> </dl> </div> <div class="section" id="qapidoc-1996"> <h4>Since<a class="headerlink" href="#qapidoc-1996" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2003"> <h3><a class="toc-backref" href="#id316"><code class="docutils literal notranslate"><span class="pre">transaction</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2003" title="Permalink to this headline">¶</a></h3> <p>Executes a number of transactionable QMP commands atomically. If any operation fails, then the entire set of actions will be abandoned and the appropriate error returned.</p> <p>For external snapshots, the dictionary contains the device, the file to use for the new snapshot, and the format. The default format, if not specified, is qcow2.</p> <p>Each new snapshot defaults to being created by QEMU (wiping any contents if the file already exists), but it is also possible to reuse an externally-created file. In the latter case, you should ensure that the new image file has the same contents as the current one; QEMU cannot perform any meaningful check. Typically this is achieved by using the current image file as the backing file for the new image.</p> <p>On failure, the original disks pre-snapshot attempt will be used.</p> <p>For internal snapshots, the dictionary contains the device and the snapshot’s name. If an internal snapshot matching name already exists, the request will be rejected. Only some image formats support it, for example, qcow2, and rbd,</p> <p>On failure, qemu will try delete the newly created internal snapshot in the transaction. When an I/O error occurs during deletion, the user needs to fix it later with qemu-img or other command.</p> <div class="section" id="qapidoc-1998"> <h4>Arguments<a class="headerlink" href="#qapidoc-1998" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">actions</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">TransactionAction</span></code></dt> <dd>List of <code class="docutils literal notranslate"><span class="pre">TransactionAction</span></code>; information needed for the respective operations.</dd> <dt><code class="docutils literal notranslate"><span class="pre">properties</span></code>: <code class="docutils literal notranslate"><span class="pre">TransactionProperties</span></code> (optional)</dt> <dd>structure of additional options to control the execution of the transaction. See <code class="docutils literal notranslate"><span class="pre">TransactionProperties</span></code> for additional detail.</dd> </dl> </div> <div class="section" id="qapidoc-1999"> <h4>Returns<a class="headerlink" href="#qapidoc-1999" title="Permalink to this headline">¶</a></h4> <p>nothing on success</p> <p>Errors depend on the operations of the transaction</p> </div> <div class="section" id="qapidoc-2000"> <h4>Note<a class="headerlink" href="#qapidoc-2000" title="Permalink to this headline">¶</a></h4> <p>The transaction aborts on the first failure. Therefore, there will be information on only one failed operation returned in an error condition, and subsequent actions will not have been attempted.</p> </div> <div class="section" id="qapidoc-2001"> <h4>Since<a class="headerlink" href="#qapidoc-2001" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> <div class="section" id="qapidoc-2002"> <h4>Example<a class="headerlink" href="#qapidoc-2002" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"transaction"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"actions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-sync"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd0"</span><span class="p">,</span> <span class="s2">"snapshot-file"</span><span class="p">:</span> <span class="s2">"/some/place/my-image"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"qcow2"</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-sync"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"myfile"</span><span class="p">,</span> <span class="s2">"snapshot-file"</span><span class="p">:</span> <span class="s2">"/some/place/my-image2"</span><span class="p">,</span> <span class="s2">"snapshot-node-name"</span><span class="p">:</span> <span class="s2">"node3432"</span><span class="p">,</span> <span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"existing"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"qcow2"</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-sync"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd1"</span><span class="p">,</span> <span class="s2">"snapshot-file"</span><span class="p">:</span> <span class="s2">"/some/place/my-image2"</span><span class="p">,</span> <span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"existing"</span><span class="p">,</span> <span class="s2">"format"</span><span class="p">:</span> <span class="s2">"qcow2"</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"blockdev-snapshot-internal-sync"</span><span class="p">,</span> <span class="s2">"data"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"ide-hd2"</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"snapshot0"</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2004"> <h2><a class="toc-backref" href="#id317">Tracing</a><a class="headerlink" href="#qapidoc-2004" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2007"> <h3><a class="toc-backref" href="#id318"><code class="docutils literal notranslate"><span class="pre">TraceEventState</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2007" title="Permalink to this headline">¶</a></h3> <p>State of a tracing event.</p> <div class="section" id="qapidoc-2005"> <h4>Values<a class="headerlink" href="#qapidoc-2005" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unavailable</span></code></dt> <dd>The event is statically disabled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">disabled</span></code></dt> <dd>The event is dynamically disabled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code></dt> <dd>The event is dynamically enabled.</dd> </dl> </div> <div class="section" id="qapidoc-2006"> <h4>Since<a class="headerlink" href="#qapidoc-2006" title="Permalink to this headline">¶</a></h4> <p>2.2</p> </div> </div> <div class="section" id="qapidoc-2011"> <h3><a class="toc-backref" href="#id319"><code class="docutils literal notranslate"><span class="pre">TraceEventInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2011" title="Permalink to this headline">¶</a></h3> <p>Information of a tracing event.</p> <div class="section" id="qapidoc-2008"> <h4>Members<a class="headerlink" href="#qapidoc-2008" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Event name.</dd> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">TraceEventState</span></code></dt> <dd>Tracing state.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vcpu</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Whether this is a per-vCPU event (since 2.7).</dd> </dl> </div> <div class="section" id="qapidoc-2009"> An event is per-vCPU if it has the “vcpu” property in the “trace-events” files.</div> <div class="section" id="qapidoc-2010"> <h4>Since<a class="headerlink" href="#qapidoc-2010" title="Permalink to this headline">¶</a></h4> <p>2.2</p> </div> </div> <div class="section" id="qapidoc-2016"> <h3><a class="toc-backref" href="#id320"><code class="docutils literal notranslate"><span class="pre">trace-event-get-state</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2016" title="Permalink to this headline">¶</a></h3> <p>Query the state of events.</p> <div class="section" id="qapidoc-2012"> <h4>Arguments<a class="headerlink" href="#qapidoc-2012" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Event name pattern (case-sensitive glob).</dd> <dt><code class="docutils literal notranslate"><span class="pre">vcpu</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The vCPU to query (any by default; since 2.7).</dd> </dl> </div> <div class="section" id="qapidoc-2013"> <h4>Returns<a class="headerlink" href="#qapidoc-2013" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">TraceEventInfo</span></code> for the matching events</p> <p>An event is returned if:</p> <ul class="simple"> <li>its name matches the <code class="docutils literal notranslate"><span class="pre">name</span></code> pattern, and</li> <li>if <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given, the event has the “vcpu” property.</li> </ul> <p>Therefore, if <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given, the operation will only match per-vCPU events, returning their state on the specified vCPU. Special case: if <code class="docutils literal notranslate"><span class="pre">name</span></code> is an exact match, <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given and the event does not have the “vcpu” property, an error is returned.</p> </div> <div class="section" id="qapidoc-2014"> <h4>Since<a class="headerlink" href="#qapidoc-2014" title="Permalink to this headline">¶</a></h4> <p>2.2</p> </div> <div class="section" id="qapidoc-2015"> <h4>Example<a class="headerlink" href="#qapidoc-2015" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"trace-event-get-state"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"qemu_memalign"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"qemu_memalign"</span><span class="p">,</span> <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"disabled"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2021"> <h3><a class="toc-backref" href="#id321"><code class="docutils literal notranslate"><span class="pre">trace-event-set-state</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2021" title="Permalink to this headline">¶</a></h3> <p>Set the dynamic tracing state of events.</p> <div class="section" id="qapidoc-2017"> <h4>Arguments<a class="headerlink" href="#qapidoc-2017" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Event name pattern (case-sensitive glob).</dd> <dt><code class="docutils literal notranslate"><span class="pre">enable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Whether to enable tracing.</dd> <dt><code class="docutils literal notranslate"><span class="pre">ignore-unavailable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Do not match unavailable events with <code class="docutils literal notranslate"><span class="pre">name</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">vcpu</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The vCPU to act upon (all by default; since 2.7).</dd> </dl> </div> <div class="section" id="qapidoc-2018"> <p>An event’s state is modified if: - its name matches the <code class="docutils literal notranslate"><span class="pre">name</span></code> pattern, and - if <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given, the event has the “vcpu” property.</p> <p>Therefore, if <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given, the operation will only match per-vCPU events, setting their state on the specified vCPU. Special case: if <code class="docutils literal notranslate"><span class="pre">name</span></code> is an exact match, <code class="docutils literal notranslate"><span class="pre">vcpu</span></code> is given and the event does not have the “vcpu” property, an error is returned.</p> </div> <div class="section" id="qapidoc-2019"> <h4>Since<a class="headerlink" href="#qapidoc-2019" title="Permalink to this headline">¶</a></h4> <p>2.2</p> </div> <div class="section" id="qapidoc-2020"> <h4>Example<a class="headerlink" href="#qapidoc-2020" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"trace-event-set-state"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"qemu_memalign"</span><span class="p">,</span> <span class="s2">"enable"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2022"> <h2><a class="toc-backref" href="#id322">Compatibility policy</a><a class="headerlink" href="#qapidoc-2022" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2025"> <h3><a class="toc-backref" href="#id323"><code class="docutils literal notranslate"><span class="pre">CompatPolicyInput</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2025" title="Permalink to this headline">¶</a></h3> <p>Policy for handling “funny” input.</p> <div class="section" id="qapidoc-2023"> <h4>Values<a class="headerlink" href="#qapidoc-2023" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">accept</span></code></dt> <dd>Accept silently</dd> <dt><code class="docutils literal notranslate"><span class="pre">reject</span></code></dt> <dd>Reject with an error</dd> <dt><code class="docutils literal notranslate"><span class="pre">crash</span></code></dt> <dd>abort() the process</dd> </dl> </div> <div class="section" id="qapidoc-2024"> <h4>Since<a class="headerlink" href="#qapidoc-2024" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2028"> <h3><a class="toc-backref" href="#id324"><code class="docutils literal notranslate"><span class="pre">CompatPolicyOutput</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2028" title="Permalink to this headline">¶</a></h3> <p>Policy for handling “funny” output.</p> <div class="section" id="qapidoc-2026"> <h4>Values<a class="headerlink" href="#qapidoc-2026" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">accept</span></code></dt> <dd>Pass on unchanged</dd> <dt><code class="docutils literal notranslate"><span class="pre">hide</span></code></dt> <dd>Filter out</dd> </dl> </div> <div class="section" id="qapidoc-2027"> <h4>Since<a class="headerlink" href="#qapidoc-2027" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2031"> <h3><a class="toc-backref" href="#id325"><code class="docutils literal notranslate"><span class="pre">CompatPolicy</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2031" title="Permalink to this headline">¶</a></h3> <p>Policy for handling deprecated management interfaces.</p> <p>This is intended for testing users of the management interfaces.</p> <p>Limitation: covers only syntactic aspects of QMP, i.e. stuff tagged with feature ‘deprecated’. We may want to extend it to cover semantic aspects, CLI, and experimental features.</p> <p>Limitation: deprecated-output policy <code class="docutils literal notranslate"><span class="pre">hide</span></code> is not implemented for enumeration values. They behave the same as with policy <code class="docutils literal notranslate"><span class="pre">accept</span></code>.</p> <div class="section" id="qapidoc-2029"> <h4>Members<a class="headerlink" href="#qapidoc-2029" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated-input</span></code>: <code class="docutils literal notranslate"><span class="pre">CompatPolicyInput</span></code> (optional)</dt> <dd>how to handle deprecated input (default ‘accept’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">deprecated-output</span></code>: <code class="docutils literal notranslate"><span class="pre">CompatPolicyOutput</span></code> (optional)</dt> <dd>how to handle deprecated output (default ‘accept’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unstable-input</span></code>: <code class="docutils literal notranslate"><span class="pre">CompatPolicyInput</span></code> (optional)</dt> <dd>how to handle unstable input (default ‘accept’) (since 6.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unstable-output</span></code>: <code class="docutils literal notranslate"><span class="pre">CompatPolicyOutput</span></code> (optional)</dt> <dd>how to handle unstable output (default ‘accept’) (since 6.2)</dd> </dl> </div> <div class="section" id="qapidoc-2030"> <h4>Since<a class="headerlink" href="#qapidoc-2030" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> </div> <div class="section" id="qapidoc-2032"> <h2><a class="toc-backref" href="#id326">QMP monitor control</a><a class="headerlink" href="#qapidoc-2032" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2037"> <h3><a class="toc-backref" href="#id327"><code class="docutils literal notranslate"><span class="pre">qmp_capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2037" title="Permalink to this headline">¶</a></h3> <p>Enable QMP capabilities.</p> <p>Arguments:</p> <div class="section" id="qapidoc-2033"> <h4>Arguments<a class="headerlink" href="#qapidoc-2033" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enable</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">QMPCapability</span></code> (optional)</dt> <dd>An optional list of QMPCapability values to enable. The client must not enable any capability that is not mentioned in the QMP greeting message. If the field is not provided, it means no QMP capabilities will be enabled. (since 2.12)</dd> </dl> </div> <div class="section" id="qapidoc-2034"> <h4>Example<a class="headerlink" href="#qapidoc-2034" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"qmp_capabilities"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enable"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"oob"</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2035"> <h4>Notes<a class="headerlink" href="#qapidoc-2035" title="Permalink to this headline">¶</a></h4> <p>This command is valid exactly when first connecting: it must be issued before any other command will be accepted, and will fail once the monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)</p> <p>The QMP client needs to explicitly enable QMP capabilities, otherwise all the QMP capabilities will be turned off by default.</p> </div> <div class="section" id="qapidoc-2036"> <h4>Since<a class="headerlink" href="#qapidoc-2036" title="Permalink to this headline">¶</a></h4> <p>0.13</p> </div> </div> <div class="section" id="qapidoc-2040"> <h3><a class="toc-backref" href="#id328"><code class="docutils literal notranslate"><span class="pre">QMPCapability</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2040" title="Permalink to this headline">¶</a></h3> <p>Enumeration of capabilities to be advertised during initial client connection, used for agreeing on particular QMP extension behaviors.</p> <div class="section" id="qapidoc-2038"> <h4>Values<a class="headerlink" href="#qapidoc-2038" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">oob</span></code></dt> <dd>QMP ability to support out-of-band requests. (Please refer to qmp-spec.txt for more information on OOB)</dd> </dl> </div> <div class="section" id="qapidoc-2039"> <h4>Since<a class="headerlink" href="#qapidoc-2039" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2043"> <h3><a class="toc-backref" href="#id329"><code class="docutils literal notranslate"><span class="pre">VersionTriple</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2043" title="Permalink to this headline">¶</a></h3> <p>A three-part version number.</p> <div class="section" id="qapidoc-2041"> <h4>Members<a class="headerlink" href="#qapidoc-2041" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">major</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The major version number.</dd> <dt><code class="docutils literal notranslate"><span class="pre">minor</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The minor version number.</dd> <dt><code class="docutils literal notranslate"><span class="pre">micro</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The micro version number.</dd> </dl> </div> <div class="section" id="qapidoc-2042"> <h4>Since<a class="headerlink" href="#qapidoc-2042" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-2046"> <h3><a class="toc-backref" href="#id330"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2046" title="Permalink to this headline">¶</a></h3> <p>A description of QEMU’s version.</p> <div class="section" id="qapidoc-2044"> <h4>Members<a class="headerlink" href="#qapidoc-2044" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">qemu</span></code>: <code class="docutils literal notranslate"><span class="pre">VersionTriple</span></code></dt> <dd>The version of QEMU. By current convention, a micro version of 50 signifies a development branch. A micro version greater than or equal to 90 signifies a release candidate for the next minor version. A micro version of less than 50 signifies a stable release.</dd> <dt><code class="docutils literal notranslate"><span class="pre">package</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>QEMU will always set this field to an empty string. Downstream versions of QEMU should set this to a non-empty string. The exact format depends on the downstream however it highly recommended that a unique name is used.</dd> </dl> </div> <div class="section" id="qapidoc-2045"> <h4>Since<a class="headerlink" href="#qapidoc-2045" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2050"> <h3><a class="toc-backref" href="#id331"><code class="docutils literal notranslate"><span class="pre">query-version</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2050" title="Permalink to this headline">¶</a></h3> <p>Returns the current version of QEMU.</p> <div class="section" id="qapidoc-2047"> <h4>Returns<a class="headerlink" href="#qapidoc-2047" title="Permalink to this headline">¶</a></h4> <p>A <code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code> object describing the current version of QEMU.</p> </div> <div class="section" id="qapidoc-2048"> <h4>Since<a class="headerlink" href="#qapidoc-2048" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2049"> <h4>Example<a class="headerlink" href="#qapidoc-2049" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-version"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:{</span> <span class="s2">"qemu"</span><span class="p">:{</span> <span class="s2">"major"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"minor"</span><span class="p">:</span><span class="mi">11</span><span class="p">,</span> <span class="s2">"micro"</span><span class="p">:</span><span class="mi">5</span> <span class="p">},</span> <span class="s2">"package"</span><span class="p">:</span><span class="s2">""</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2053"> <h3><a class="toc-backref" href="#id332"><code class="docutils literal notranslate"><span class="pre">CommandInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2053" title="Permalink to this headline">¶</a></h3> <p>Information about a QMP command</p> <div class="section" id="qapidoc-2051"> <h4>Members<a class="headerlink" href="#qapidoc-2051" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The command name</dd> </dl> </div> <div class="section" id="qapidoc-2052"> <h4>Since<a class="headerlink" href="#qapidoc-2052" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2058"> <h3><a class="toc-backref" href="#id333"><code class="docutils literal notranslate"><span class="pre">query-commands</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2058" title="Permalink to this headline">¶</a></h3> <p>Return a list of supported QMP commands by this server</p> <div class="section" id="qapidoc-2054"> <h4>Returns<a class="headerlink" href="#qapidoc-2054" title="Permalink to this headline">¶</a></h4> <p>A list of <code class="docutils literal notranslate"><span class="pre">CommandInfo</span></code> for all supported commands</p> </div> <div class="section" id="qapidoc-2055"> <h4>Since<a class="headerlink" href="#qapidoc-2055" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2056"> <h4>Example<a class="headerlink" href="#qapidoc-2056" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-commands"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"query-balloon"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span><span class="s2">"system_powerdown"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2057"> <h4>Note<a class="headerlink" href="#qapidoc-2057" title="Permalink to this headline">¶</a></h4> <p>This example has been shortened as the real response is too long.</p> </div> </div> <div class="section" id="qapidoc-2061"> <h3><a class="toc-backref" href="#id334"><code class="docutils literal notranslate"><span class="pre">quit</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2061" title="Permalink to this headline">¶</a></h3> <p>This command will cause the QEMU process to exit gracefully. While every attempt is made to send the QMP response before terminating, this is not guaranteed. When using this interface, a premature EOF would not be unexpected.</p> <div class="section" id="qapidoc-2059"> <h4>Since<a class="headerlink" href="#qapidoc-2059" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2060"> <h4>Example<a class="headerlink" href="#qapidoc-2060" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"quit"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2064"> <h3><a class="toc-backref" href="#id335"><code class="docutils literal notranslate"><span class="pre">MonitorMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2064" title="Permalink to this headline">¶</a></h3> <p>An enumeration of monitor modes.</p> <div class="section" id="qapidoc-2062"> <h4>Values<a class="headerlink" href="#qapidoc-2062" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">readline</span></code></dt> <dd>HMP monitor (human-oriented command line interface)</dd> <dt><code class="docutils literal notranslate"><span class="pre">control</span></code></dt> <dd>QMP monitor (JSON-based machine interface)</dd> </dl> </div> <div class="section" id="qapidoc-2063"> <h4>Since<a class="headerlink" href="#qapidoc-2063" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2067"> <h3><a class="toc-backref" href="#id336"><code class="docutils literal notranslate"><span class="pre">MonitorOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2067" title="Permalink to this headline">¶</a></h3> <p>Options to be used for adding a new monitor.</p> <div class="section" id="qapidoc-2065"> <h4>Members<a class="headerlink" href="#qapidoc-2065" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Name of the monitor</dd> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">MonitorMode</span></code> (optional)</dt> <dd>Selects the monitor mode (default: readline in the system emulator, control in qemu-storage-daemon)</dd> <dt><code class="docutils literal notranslate"><span class="pre">pretty</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>Enables pretty printing (QMP only)</dd> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Name of a character device to expose the monitor on</dd> </dl> </div> <div class="section" id="qapidoc-2066"> <h4>Since<a class="headerlink" href="#qapidoc-2066" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> </div> <div class="section" id="qapidoc-2068"> <h2><a class="toc-backref" href="#id337">QMP introspection</a><a class="headerlink" href="#qapidoc-2068" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2072"> <h3><a class="toc-backref" href="#id338"><code class="docutils literal notranslate"><span class="pre">query-qmp-schema</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2072" title="Permalink to this headline">¶</a></h3> <p>Command query-qmp-schema exposes the QMP wire ABI as an array of SchemaInfo. This lets QMP clients figure out what commands and events are available in this QEMU, and their parameters and results.</p> <p>However, the SchemaInfo can’t reflect all the rules and restrictions that apply to QMP. It’s interface introspection (figuring out what’s there), not interface specification. The specification is in the QAPI schema.</p> <p>Furthermore, while we strive to keep the QMP wire format backwards-compatible across qemu versions, the introspection output is not guaranteed to have the same stability. For example, one version of qemu may list an object member as an optional non-variant, while another lists the same member only through the object’s variants; or the type of a member may change from a generic string into a specific enum or from one specific type into an alternate that includes the original type alongside something else.</p> <div class="section" id="qapidoc-2069"> <h4>Returns<a class="headerlink" href="#qapidoc-2069" title="Permalink to this headline">¶</a></h4> <p>array of <code class="docutils literal notranslate"><span class="pre">SchemaInfo</span></code>, where each element describes an entity in the ABI: command, event, type, …</p> <p>The order of the various SchemaInfo is unspecified; however, all names are guaranteed to be unique (no name will be duplicated with different meta-types).</p> </div> <div class="section" id="qapidoc-2070"> <h4>Note<a class="headerlink" href="#qapidoc-2070" title="Permalink to this headline">¶</a></h4> <p>the QAPI schema is also used to help define <em>internal</em> interfaces, by defining QAPI types. These are not part of the QMP wire ABI, and therefore not returned by this command.</p> </div> <div class="section" id="qapidoc-2071"> <h4>Since<a class="headerlink" href="#qapidoc-2071" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2075"> <h3><a class="toc-backref" href="#id339"><code class="docutils literal notranslate"><span class="pre">SchemaMetaType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2075" title="Permalink to this headline">¶</a></h3> <p>This is a <code class="docutils literal notranslate"><span class="pre">SchemaInfo</span></code>’s meta type, i.e. the kind of entity it describes.</p> <div class="section" id="qapidoc-2073"> <h4>Values<a class="headerlink" href="#qapidoc-2073" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">builtin</span></code></dt> <dd>a predefined type such as ‘int’ or ‘bool’.</dd> <dt><code class="docutils literal notranslate"><span class="pre">enum</span></code></dt> <dd>an enumeration type</dd> <dt><code class="docutils literal notranslate"><span class="pre">array</span></code></dt> <dd>an array type</dd> <dt><code class="docutils literal notranslate"><span class="pre">object</span></code></dt> <dd>an object type (struct or union)</dd> <dt><code class="docutils literal notranslate"><span class="pre">alternate</span></code></dt> <dd>an alternate type</dd> <dt><code class="docutils literal notranslate"><span class="pre">command</span></code></dt> <dd>a QMP command</dd> <dt><code class="docutils literal notranslate"><span class="pre">event</span></code></dt> <dd>a QMP event</dd> </dl> </div> <div class="section" id="qapidoc-2074"> <h4>Since<a class="headerlink" href="#qapidoc-2074" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2079"> <h3><a class="toc-backref" href="#id340"><code class="docutils literal notranslate"><span class="pre">SchemaInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2079" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2076"> <h4>Members<a class="headerlink" href="#qapidoc-2076" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the entity’s name, inherited from <code class="docutils literal notranslate"><span class="pre">base</span></code>. The SchemaInfo is always referenced by this name. Commands and events have the name defined in the QAPI schema. Unlike command and event names, type names are not part of the wire ABI. Consequently, type names are meaningless strings here, although they are still guaranteed unique regardless of <code class="docutils literal notranslate"><span class="pre">meta-type</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">meta-type</span></code>: <code class="docutils literal notranslate"><span class="pre">SchemaMetaType</span></code></dt> <dd>the entity’s meta type, inherited from <code class="docutils literal notranslate"><span class="pre">base</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">features</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>names of features associated with the entity, in no particular order. (since 4.1 for object types, 4.2 for commands, 5.0 for the rest)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoBuiltin</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"builtin"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoEnum</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"enum"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoArray</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"array"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoObject</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"object"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternate</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"alternate"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoCommand</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"command"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SchemaInfoEvent</span></code> when <code class="docutils literal notranslate"><span class="pre">meta-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"event"</span></code></dl> </div> <div class="section" id="qapidoc-2077"> Additional members depend on the value of <code class="docutils literal notranslate"><span class="pre">meta-type</span></code>.</div> <div class="section" id="qapidoc-2078"> <h4>Since<a class="headerlink" href="#qapidoc-2078" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2082"> <h3><a class="toc-backref" href="#id341"><code class="docutils literal notranslate"><span class="pre">SchemaInfoBuiltin</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2082" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘builtin’.</p> <div class="section" id="qapidoc-2080"> <h4>Members<a class="headerlink" href="#qapidoc-2080" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">json-type</span></code>: <code class="docutils literal notranslate"><span class="pre">JSONType</span></code></dt> <dd>the JSON type used for this type on the wire.</dd> </dl> </div> <div class="section" id="qapidoc-2081"> <h4>Since<a class="headerlink" href="#qapidoc-2081" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2085"> <h3><a class="toc-backref" href="#id342"><code class="docutils literal notranslate"><span class="pre">JSONType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2085" title="Permalink to this headline">¶</a></h3> <p>The four primitive and two structured types according to RFC 8259 section 1, plus ‘int’ (split off ‘number’), plus the obvious top type ‘value’.</p> <div class="section" id="qapidoc-2083"> <h4>Values<a class="headerlink" href="#qapidoc-2083" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">null</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">object</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">array</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">value</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2084"> <h4>Since<a class="headerlink" href="#qapidoc-2084" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2090"> <h3><a class="toc-backref" href="#id343"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnum</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2090" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘enum’.</p> <div class="section" id="qapidoc-2086"> <h4>Members<a class="headerlink" href="#qapidoc-2086" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">members</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SchemaInfoEnumMember</span></code></dt> <dd>the enum type’s members, in no particular order (since 6.2).</dd> <dt><code class="docutils literal notranslate"><span class="pre">values</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>the enumeration type’s member names, in no particular order. Redundant with <code class="docutils literal notranslate"><span class="pre">members</span></code>. Just for backward compatibility.</dd> </dl> </div> <div class="section" id="qapidoc-2087"> <h4>Features<a class="headerlink" href="#qapidoc-2087" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">values</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">members</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-2088"> Values of this type are JSON string on the wire.</div> <div class="section" id="qapidoc-2089"> <h4>Since<a class="headerlink" href="#qapidoc-2089" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2093"> <h3><a class="toc-backref" href="#id344"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEnumMember</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2093" title="Permalink to this headline">¶</a></h3> <p>An object member.</p> <div class="section" id="qapidoc-2091"> <h4>Members<a class="headerlink" href="#qapidoc-2091" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the member’s name, as defined in the QAPI schema.</dd> <dt><code class="docutils literal notranslate"><span class="pre">features</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>names of features associated with the member, in no particular order.</dd> </dl> </div> <div class="section" id="qapidoc-2092"> <h4>Since<a class="headerlink" href="#qapidoc-2092" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2097"> <h3><a class="toc-backref" href="#id345"><code class="docutils literal notranslate"><span class="pre">SchemaInfoArray</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2097" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘array’.</p> <div class="section" id="qapidoc-2094"> <h4>Members<a class="headerlink" href="#qapidoc-2094" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">element-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the array type’s element type.</dd> </dl> </div> <div class="section" id="qapidoc-2095"> Values of this type are JSON array on the wire.</div> <div class="section" id="qapidoc-2096"> <h4>Since<a class="headerlink" href="#qapidoc-2096" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2101"> <h3><a class="toc-backref" href="#id346"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObject</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2101" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘object’.</p> <div class="section" id="qapidoc-2098"> <h4>Members<a class="headerlink" href="#qapidoc-2098" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">members</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SchemaInfoObjectMember</span></code></dt> <dd>the object type’s (non-variant) members, in no particular order.</dd> <dt><code class="docutils literal notranslate"><span class="pre">tag</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the member serving as type tag. An element of <code class="docutils literal notranslate"><span class="pre">members</span></code> with this name must exist.</dd> <dt><code class="docutils literal notranslate"><span class="pre">variants</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SchemaInfoObjectVariant</span></code> (optional)</dt> <dd>variant members, i.e. additional members that depend on the type tag’s value. Present exactly when <code class="docutils literal notranslate"><span class="pre">tag</span></code> is present. The variants are in no particular order, and may even differ from the order of the values of the enum type of the <code class="docutils literal notranslate"><span class="pre">tag</span></code>.</dd> </dl> </div> <div class="section" id="qapidoc-2099"> Values of this type are JSON object on the wire.</div> <div class="section" id="qapidoc-2100"> <h4>Since<a class="headerlink" href="#qapidoc-2100" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2104"> <h3><a class="toc-backref" href="#id347"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectMember</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2104" title="Permalink to this headline">¶</a></h3> <p>An object member.</p> <div class="section" id="qapidoc-2102"> <h4>Members<a class="headerlink" href="#qapidoc-2102" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the member’s name, as defined in the QAPI schema.</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the member’s type.</dd> <dt><code class="docutils literal notranslate"><span class="pre">default</span></code>: <code class="docutils literal notranslate"><span class="pre">value</span></code> (optional)</dt> <dd>default when used as command parameter. If absent, the parameter is mandatory. If present, the value must be null. The parameter is optional, and behavior when it’s missing is not specified here. Future extension: if present and non-null, the parameter is optional, and defaults to this value.</dd> <dt><code class="docutils literal notranslate"><span class="pre">features</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>names of features associated with the member, in no particular order. (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-2103"> <h4>Since<a class="headerlink" href="#qapidoc-2103" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2107"> <h3><a class="toc-backref" href="#id348"><code class="docutils literal notranslate"><span class="pre">SchemaInfoObjectVariant</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2107" title="Permalink to this headline">¶</a></h3> <p>The variant members for a value of the type tag.</p> <div class="section" id="qapidoc-2105"> <h4>Members<a class="headerlink" href="#qapidoc-2105" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">case</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>a value of the type tag.</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the object type that provides the variant members when the type tag has value <code class="docutils literal notranslate"><span class="pre">case</span></code>.</dd> </dl> </div> <div class="section" id="qapidoc-2106"> <h4>Since<a class="headerlink" href="#qapidoc-2106" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2111"> <h3><a class="toc-backref" href="#id349"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternate</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2111" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘alternate’.</p> <div class="section" id="qapidoc-2108"> <h4>Members<a class="headerlink" href="#qapidoc-2108" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">members</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SchemaInfoAlternateMember</span></code></dt> <dd>the alternate type’s members, in no particular order. The members’ wire encoding is distinct, see docs/devel/qapi-code-gen.txt section Alternate types.</dd> </dl> </div> <div class="section" id="qapidoc-2109"> On the wire, this can be any of the members.</div> <div class="section" id="qapidoc-2110"> <h4>Since<a class="headerlink" href="#qapidoc-2110" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2114"> <h3><a class="toc-backref" href="#id350"><code class="docutils literal notranslate"><span class="pre">SchemaInfoAlternateMember</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2114" title="Permalink to this headline">¶</a></h3> <p>An alternate member.</p> <div class="section" id="qapidoc-2112"> <h4>Members<a class="headerlink" href="#qapidoc-2112" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the member’s type.</dd> </dl> </div> <div class="section" id="qapidoc-2113"> <h4>Since<a class="headerlink" href="#qapidoc-2113" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2118"> <h3><a class="toc-backref" href="#id351"><code class="docutils literal notranslate"><span class="pre">SchemaInfoCommand</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2118" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘command’.</p> <div class="section" id="qapidoc-2115"> <h4>Members<a class="headerlink" href="#qapidoc-2115" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">arg-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the object type that provides the command’s parameters.</dd> <dt><code class="docutils literal notranslate"><span class="pre">ret-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the command’s result type.</dd> <dt><code class="docutils literal notranslate"><span class="pre">allow-oob</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether the command allows out-of-band execution, defaults to false (Since: 2.12)</dd> </dl> </div> <div class="section" id="qapidoc-2116"> <h4>TODO<a class="headerlink" href="#qapidoc-2116" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">success-response</span></code> (currently irrelevant, because it’s QGA, not QMP)</p> </div> <div class="section" id="qapidoc-2117"> <h4>Since<a class="headerlink" href="#qapidoc-2117" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2121"> <h3><a class="toc-backref" href="#id352"><code class="docutils literal notranslate"><span class="pre">SchemaInfoEvent</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2121" title="Permalink to this headline">¶</a></h3> <p>Additional SchemaInfo members for meta-type ‘event’.</p> <div class="section" id="qapidoc-2119"> <h4>Members<a class="headerlink" href="#qapidoc-2119" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">arg-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the object type that provides the event’s parameters.</dd> </dl> </div> <div class="section" id="qapidoc-2120"> <h4>Since<a class="headerlink" href="#qapidoc-2120" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> </div> <div class="section" id="qapidoc-2122"> <h2><a class="toc-backref" href="#id353">QEMU Object Model (QOM)</a><a class="headerlink" href="#qapidoc-2122" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2125"> <h3><a class="toc-backref" href="#id354"><code class="docutils literal notranslate"><span class="pre">ObjectPropertyInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2125" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2123"> <h4>Members<a class="headerlink" href="#qapidoc-2123" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the property</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><p class="first">the type of the property. This will typically come in one of four forms:</p> <ol class="last arabic simple"> <li>A primitive type such as ‘u8’, ‘u16’, ‘bool’, ‘str’, or ‘double’. These types are mapped to the appropriate JSON type.</li> <li>A child type in the form ‘child<subtype>’ where subtype is a qdev device type name. Child properties create the composition tree.</li> <li>A link type in the form ‘link<subtype>’ where subtype is a qdev device type name. Link properties form the device model graph.</li> </ol> </dd> <dt><code class="docutils literal notranslate"><span class="pre">description</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>if specified, the description of the property.</dd> <dt><code class="docutils literal notranslate"><span class="pre">default-value</span></code>: <code class="docutils literal notranslate"><span class="pre">value</span></code> (optional)</dt> <dd>the default value, if any (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-2124"> <h4>Since<a class="headerlink" href="#qapidoc-2124" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2130"> <h3><a class="toc-backref" href="#id355"><code class="docutils literal notranslate"><span class="pre">qom-list</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2130" title="Permalink to this headline">¶</a></h3> <p>This command will list any properties of a object given a path in the object model.</p> <div class="section" id="qapidoc-2126"> <h4>Arguments<a class="headerlink" href="#qapidoc-2126" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path within the object model. See <code class="docutils literal notranslate"><span class="pre">qom-get</span></code> for a description of this parameter.</dd> </dl> </div> <div class="section" id="qapidoc-2127"> <h4>Returns<a class="headerlink" href="#qapidoc-2127" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">ObjectPropertyInfo</span></code> that describe the properties of the object.</p> </div> <div class="section" id="qapidoc-2128"> <h4>Since<a class="headerlink" href="#qapidoc-2128" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2129"> <h4>Example<a class="headerlink" href="#qapidoc-2129" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"qom-list"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/chardevs"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"type"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"string"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"parallel0"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"child<chardev-vc>"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"serial0"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"child<chardev-vc>"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mon0"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"child<chardev-stdio>"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2135"> <h3><a class="toc-backref" href="#id356"><code class="docutils literal notranslate"><span class="pre">qom-get</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2135" title="Permalink to this headline">¶</a></h3> <p>This command will get a property from a object model path and return the value.</p> <div class="section" id="qapidoc-2131"> <h4>Arguments<a class="headerlink" href="#qapidoc-2131" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><p class="first">The path within the object model. There are two forms of supported paths–absolute and partial paths.</p> <p>Absolute paths are derived from the root object and can follow child<> or link<> properties. Since they can follow link<> properties, they can be arbitrarily long. Absolute paths look like absolute filenames and are prefixed with a leading slash.</p> <p class="last">Partial paths look like relative filenames. They do not begin with a prefix. The matching rules for partial paths are subtle but designed to make specifying objects easy. At each level of the composition tree, the partial path is matched as an absolute path. The first match is not returned. At least two matches are searched for. A successful result is only returned if only one match is found. If more than one match is found, a flag is return to indicate that the match was ambiguous.</p> </dd> <dt><code class="docutils literal notranslate"><span class="pre">property</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>The property name to read</dd> </dl> </div> <div class="section" id="qapidoc-2132"> <h4>Returns<a class="headerlink" href="#qapidoc-2132" title="Permalink to this headline">¶</a></h4> <p>The property value. The type depends on the property type. child<> and link<> properties are returned as #str pathnames. All integer property types (u8, u16, etc) are returned as #int.</p> </div> <div class="section" id="qapidoc-2133"> <h4>Since<a class="headerlink" href="#qapidoc-2133" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2134"> <h4>Example<a class="headerlink" href="#qapidoc-2134" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Use</span> <span class="n">absolute</span> <span class="n">path</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"qom-get"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[0]"</span><span class="p">,</span> <span class="s2">"property"</span><span class="p">:</span> <span class="s2">"hotplugged"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="mf">2.</span> <span class="n">Use</span> <span class="n">partial</span> <span class="n">path</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"qom-get"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"unattached/sysbus"</span><span class="p">,</span> <span class="s2">"property"</span><span class="p">:</span> <span class="s2">"type"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="s2">"System"</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2139"> <h3><a class="toc-backref" href="#id357"><code class="docutils literal notranslate"><span class="pre">qom-set</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2139" title="Permalink to this headline">¶</a></h3> <p>This command will set a property from a object model path.</p> <div class="section" id="qapidoc-2136"> <h4>Arguments<a class="headerlink" href="#qapidoc-2136" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>see <code class="docutils literal notranslate"><span class="pre">qom-get</span></code> for a description of this parameter</dd> <dt><code class="docutils literal notranslate"><span class="pre">property</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the property name to set</dd> <dt><code class="docutils literal notranslate"><span class="pre">value</span></code>: <code class="docutils literal notranslate"><span class="pre">value</span></code></dt> <dd>a value who’s type is appropriate for the property type. See <code class="docutils literal notranslate"><span class="pre">qom-get</span></code> for a description of type mapping.</dd> </dl> </div> <div class="section" id="qapidoc-2137"> <h4>Since<a class="headerlink" href="#qapidoc-2137" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2138"> <h4>Example<a class="headerlink" href="#qapidoc-2138" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"qom-set"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/machine"</span><span class="p">,</span> <span class="s2">"property"</span><span class="p">:</span> <span class="s2">"graphics"</span><span class="p">,</span> <span class="s2">"value"</span><span class="p">:</span> <span class="n">false</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2142"> <h3><a class="toc-backref" href="#id358"><code class="docutils literal notranslate"><span class="pre">ObjectTypeInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2142" title="Permalink to this headline">¶</a></h3> <p>This structure describes a search result from <code class="docutils literal notranslate"><span class="pre">qom-list-types</span></code></p> <div class="section" id="qapidoc-2140"> <h4>Members<a class="headerlink" href="#qapidoc-2140" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the type name found in the search</dd> <dt><code class="docutils literal notranslate"><span class="pre">abstract</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>the type is abstract and can’t be directly instantiated. Omitted if false. (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">parent</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Name of parent type, if any (since 2.10)</dd> </dl> </div> <div class="section" id="qapidoc-2141"> <h4>Since<a class="headerlink" href="#qapidoc-2141" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-2146"> <h3><a class="toc-backref" href="#id359"><code class="docutils literal notranslate"><span class="pre">qom-list-types</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2146" title="Permalink to this headline">¶</a></h3> <p>This command will return a list of types given search parameters</p> <div class="section" id="qapidoc-2143"> <h4>Arguments<a class="headerlink" href="#qapidoc-2143" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">implements</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>if specified, only return types that implement this type name</dd> <dt><code class="docutils literal notranslate"><span class="pre">abstract</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, include abstract types in the results</dd> </dl> </div> <div class="section" id="qapidoc-2144"> <h4>Returns<a class="headerlink" href="#qapidoc-2144" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">ObjectTypeInfo</span></code> or an empty list if no results are found</p> </div> <div class="section" id="qapidoc-2145"> <h4>Since<a class="headerlink" href="#qapidoc-2145" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> </div> <div class="section" id="qapidoc-2151"> <h3><a class="toc-backref" href="#id360"><code class="docutils literal notranslate"><span class="pre">qom-list-properties</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2151" title="Permalink to this headline">¶</a></h3> <p>List properties associated with a QOM object.</p> <div class="section" id="qapidoc-2147"> <h4>Arguments<a class="headerlink" href="#qapidoc-2147" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">typename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the type name of an object</dd> </dl> </div> <div class="section" id="qapidoc-2148"> <h4>Note<a class="headerlink" href="#qapidoc-2148" title="Permalink to this headline">¶</a></h4> <p>objects can create properties at runtime, for example to describe links between different devices and/or objects. These properties are not included in the output of this command.</p> </div> <div class="section" id="qapidoc-2149"> <h4>Returns<a class="headerlink" href="#qapidoc-2149" title="Permalink to this headline">¶</a></h4> <p>a list of ObjectPropertyInfo describing object properties</p> </div> <div class="section" id="qapidoc-2150"> <h4>Since<a class="headerlink" href="#qapidoc-2150" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2154"> <h3><a class="toc-backref" href="#id361"><code class="docutils literal notranslate"><span class="pre">CanHostSocketcanProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2154" title="Permalink to this headline">¶</a></h3> <p>Properties for can-host-socketcan objects.</p> <div class="section" id="qapidoc-2152"> <h4>Members<a class="headerlink" href="#qapidoc-2152" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">if</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>interface name of the host system CAN bus to connect to</dd> <dt><code class="docutils literal notranslate"><span class="pre">canbus</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>object ID of the can-bus object to connect to the host interface</dd> </dl> </div> <div class="section" id="qapidoc-2153"> <h4>Since<a class="headerlink" href="#qapidoc-2153" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2157"> <h3><a class="toc-backref" href="#id362"><code class="docutils literal notranslate"><span class="pre">ColoCompareProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2157" title="Permalink to this headline">¶</a></h3> <p>Properties for colo-compare objects.</p> <div class="section" id="qapidoc-2155"> <h4>Members<a class="headerlink" href="#qapidoc-2155" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">primary_in</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the character device backend to use for the primary input (incoming packets are redirected to <code class="docutils literal notranslate"><span class="pre">outdev</span></code>)</dd> <dt><code class="docutils literal notranslate"><span class="pre">secondary_in</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the character device backend to use for secondary input (incoming packets are only compared to the input on <code class="docutils literal notranslate"><span class="pre">primary_in</span></code> and then dropped)</dd> <dt><code class="docutils literal notranslate"><span class="pre">outdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the character device backend to use for output</dd> <dt><code class="docutils literal notranslate"><span class="pre">iothread</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>name of the iothread to run in</dd> <dt><code class="docutils literal notranslate"><span class="pre">notify_dev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the character device backend to be used to communicate with the remote colo-frame (only for Xen COLO)</dd> <dt><code class="docutils literal notranslate"><span class="pre">compare_timeout</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum time to hold a packet from <code class="docutils literal notranslate"><span class="pre">primary_in</span></code> for comparison with an incoming packet on <code class="docutils literal notranslate"><span class="pre">secondary_in</span></code> in milliseconds (default: 3000)</dd> <dt><code class="docutils literal notranslate"><span class="pre">expired_scan_cycle</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the interval at which colo-compare checks whether packets from <code class="docutils literal notranslate"><span class="pre">primary</span></code> have timed out, in milliseconds (default: 3000)</dd> <dt><code class="docutils literal notranslate"><span class="pre">max_queue_size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum number of packets to keep in the queue for comparing with incoming packets from <code class="docutils literal notranslate"><span class="pre">secondary_in</span></code>. If the queue is full and additional packets are received, the additional packets are dropped. (default: 1024)</dd> <dt><code class="docutils literal notranslate"><span class="pre">vnet_hdr_support</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, vnet header support is enabled (default: false)</dd> </dl> </div> <div class="section" id="qapidoc-2156"> <h4>Since<a class="headerlink" href="#qapidoc-2156" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2160"> <h3><a class="toc-backref" href="#id363"><code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2160" title="Permalink to this headline">¶</a></h3> <p>Properties for cryptodev-backend and cryptodev-backend-builtin objects.</p> <div class="section" id="qapidoc-2158"> <h4>Members<a class="headerlink" href="#qapidoc-2158" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">queues</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the number of queues for the cryptodev backend. Ignored for cryptodev-backend and must be 1 for cryptodev-backend-builtin. (default: 1)</dd> </dl> </div> <div class="section" id="qapidoc-2159"> <h4>Since<a class="headerlink" href="#qapidoc-2159" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2163"> <h3><a class="toc-backref" href="#id364"><code class="docutils literal notranslate"><span class="pre">CryptodevVhostUserProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2163" title="Permalink to this headline">¶</a></h3> <p>Properties for cryptodev-vhost-user objects.</p> <div class="section" id="qapidoc-2161"> <h4>Members<a class="headerlink" href="#qapidoc-2161" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of a Unix domain socket character device that connects to the vhost-user server</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code></dl> </div> <div class="section" id="qapidoc-2162"> <h4>Since<a class="headerlink" href="#qapidoc-2162" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2166"> <h3><a class="toc-backref" href="#id365"><code class="docutils literal notranslate"><span class="pre">DBusVMStateProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2166" title="Permalink to this headline">¶</a></h3> <p>Properties for dbus-vmstate objects.</p> <div class="section" id="qapidoc-2164"> <h4>Members<a class="headerlink" href="#qapidoc-2164" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the DBus bus to connect to</dd> <dt><code class="docutils literal notranslate"><span class="pre">id-list</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>a comma separated list of DBus IDs of helpers whose data should be included in the VM state on migration</dd> </dl> </div> <div class="section" id="qapidoc-2165"> <h4>Since<a class="headerlink" href="#qapidoc-2165" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2169"> <h3><a class="toc-backref" href="#id366"><code class="docutils literal notranslate"><span class="pre">NetfilterInsert</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2169" title="Permalink to this headline">¶</a></h3> <p>Indicates where to insert a netfilter relative to a given other filter.</p> <div class="section" id="qapidoc-2167"> <h4>Values<a class="headerlink" href="#qapidoc-2167" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">before</span></code></dt> <dd>insert before the specified filter</dd> <dt><code class="docutils literal notranslate"><span class="pre">behind</span></code></dt> <dd>insert behind the specified filter</dd> </dl> </div> <div class="section" id="qapidoc-2168"> <h4>Since<a class="headerlink" href="#qapidoc-2168" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2172"> <h3><a class="toc-backref" href="#id367"><code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2172" title="Permalink to this headline">¶</a></h3> <p>Properties for objects of classes derived from netfilter.</p> <div class="section" id="qapidoc-2170"> <h4>Members<a class="headerlink" href="#qapidoc-2170" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">netdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>id of the network device backend to filter</dd> <dt><code class="docutils literal notranslate"><span class="pre">queue</span></code>: <code class="docutils literal notranslate"><span class="pre">NetFilterDirection</span></code> (optional)</dt> <dd>indicates which queue(s) to filter (default: all)</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>indicates whether the filter is enabled (“on”) or disabled (“off”) (default: “on”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">position</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>specifies where the filter should be inserted in the filter list. “head” means the filter is inserted at the head of the filter list, before any existing filters. “tail” means the filter is inserted at the tail of the filter list, behind any existing filters (default). “id=<id>” means the filter is inserted before or behind the filter specified by <id>, depending on the <code class="docutils literal notranslate"><span class="pre">insert</span></code> property. (default: “tail”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">insert</span></code>: <code class="docutils literal notranslate"><span class="pre">NetfilterInsert</span></code> (optional)</dt> <dd>where to insert the filter relative to the filter given in <code class="docutils literal notranslate"><span class="pre">position</span></code>. Ignored if <code class="docutils literal notranslate"><span class="pre">position</span></code> is “head” or “tail”. (default: behind)</dd> </dl> </div> <div class="section" id="qapidoc-2171"> <h4>Since<a class="headerlink" href="#qapidoc-2171" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2175"> <h3><a class="toc-backref" href="#id368"><code class="docutils literal notranslate"><span class="pre">FilterBufferProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2175" title="Permalink to this headline">¶</a></h3> <p>Properties for filter-buffer objects.</p> <div class="section" id="qapidoc-2173"> <h4>Members<a class="headerlink" href="#qapidoc-2173" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">interval</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>a non-zero interval in microseconds. All packets arriving in the given interval are delayed until the end of the interval.</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code></dl> </div> <div class="section" id="qapidoc-2174"> <h4>Since<a class="headerlink" href="#qapidoc-2174" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2178"> <h3><a class="toc-backref" href="#id369"><code class="docutils literal notranslate"><span class="pre">FilterDumpProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2178" title="Permalink to this headline">¶</a></h3> <p>Properties for filter-dump objects.</p> <div class="section" id="qapidoc-2176"> <h4>Members<a class="headerlink" href="#qapidoc-2176" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the filename where the dumped packets should be stored</dd> <dt><code class="docutils literal notranslate"><span class="pre">maxlen</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum number of bytes in a packet that are stored (default: 65536)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code></dl> </div> <div class="section" id="qapidoc-2177"> <h4>Since<a class="headerlink" href="#qapidoc-2177" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2181"> <h3><a class="toc-backref" href="#id370"><code class="docutils literal notranslate"><span class="pre">FilterMirrorProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2181" title="Permalink to this headline">¶</a></h3> <p>Properties for filter-mirror objects.</p> <div class="section" id="qapidoc-2179"> <h4>Members<a class="headerlink" href="#qapidoc-2179" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">outdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of a character device backend to which all incoming packets are mirrored</dd> <dt><code class="docutils literal notranslate"><span class="pre">vnet_hdr_support</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, vnet header support is enabled (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code></dl> </div> <div class="section" id="qapidoc-2180"> <h4>Since<a class="headerlink" href="#qapidoc-2180" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-2184"> <h3><a class="toc-backref" href="#id371"><code class="docutils literal notranslate"><span class="pre">FilterRedirectorProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2184" title="Permalink to this headline">¶</a></h3> <p>Properties for filter-redirector objects.</p> <p>At least one of <code class="docutils literal notranslate"><span class="pre">indev</span></code> or <code class="docutils literal notranslate"><span class="pre">outdev</span></code> must be present. If both are present, they must not refer to the same character device backend.</p> <div class="section" id="qapidoc-2182"> <h4>Members<a class="headerlink" href="#qapidoc-2182" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">indev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of a character device backend from which packets are received and redirected to the filtered network device</dd> <dt><code class="docutils literal notranslate"><span class="pre">outdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of a character device backend to which all incoming packets are redirected</dd> <dt><code class="docutils literal notranslate"><span class="pre">vnet_hdr_support</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, vnet header support is enabled (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code></dl> </div> <div class="section" id="qapidoc-2183"> <h4>Since<a class="headerlink" href="#qapidoc-2183" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-2187"> <h3><a class="toc-backref" href="#id372"><code class="docutils literal notranslate"><span class="pre">FilterRewriterProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2187" title="Permalink to this headline">¶</a></h3> <p>Properties for filter-rewriter objects.</p> <div class="section" id="qapidoc-2185"> <h4>Members<a class="headerlink" href="#qapidoc-2185" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">vnet_hdr_support</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, vnet header support is enabled (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code></dl> </div> <div class="section" id="qapidoc-2186"> <h4>Since<a class="headerlink" href="#qapidoc-2186" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2190"> <h3><a class="toc-backref" href="#id373"><code class="docutils literal notranslate"><span class="pre">InputBarrierProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2190" title="Permalink to this headline">¶</a></h3> <p>Properties for input-barrier objects.</p> <div class="section" id="qapidoc-2188"> <h4>Members<a class="headerlink" href="#qapidoc-2188" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the screen name as declared in the screens section of barrier.conf</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>hostname of the Barrier server (default: “localhost”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">port</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>TCP port of the Barrier server (default: “24800”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-origin</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>x coordinate of the leftmost pixel on the guest screen (default: “0”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">y-origin</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>y coordinate of the topmost pixel on the guest screen (default: “0”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">width</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the width of secondary screen in pixels (default: “1920”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">height</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the height of secondary screen in pixels (default: “1080”)</dd> </dl> </div> <div class="section" id="qapidoc-2189"> <h4>Since<a class="headerlink" href="#qapidoc-2189" title="Permalink to this headline">¶</a></h4> <p>4.2</p> </div> </div> <div class="section" id="qapidoc-2193"> <h3><a class="toc-backref" href="#id374"><code class="docutils literal notranslate"><span class="pre">InputLinuxProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2193" title="Permalink to this headline">¶</a></h3> <p>Properties for input-linux objects.</p> <div class="section" id="qapidoc-2191"> <h4>Members<a class="headerlink" href="#qapidoc-2191" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">evdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path of the host evdev device to use</dd> <dt><code class="docutils literal notranslate"><span class="pre">grab_all</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, grab is toggled for all devices (e.g. both keyboard and mouse) instead of just one device (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">repeat</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>enables auto-repeat events (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">grab-toggle</span></code>: <code class="docutils literal notranslate"><span class="pre">GrabToggleKeys</span></code> (optional)</dt> <dd>the key or key combination that toggles device grab (default: ctrl-ctrl)</dd> </dl> </div> <div class="section" id="qapidoc-2192"> <h4>Since<a class="headerlink" href="#qapidoc-2192" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> </div> <div class="section" id="qapidoc-2196"> <h3><a class="toc-backref" href="#id375"><code class="docutils literal notranslate"><span class="pre">IothreadProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2196" title="Permalink to this headline">¶</a></h3> <p>Properties for iothread objects.</p> <div class="section" id="qapidoc-2194"> <h4>Members<a class="headerlink" href="#qapidoc-2194" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">poll-max-ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the maximum number of nanoseconds to busy wait for events. 0 means polling is disabled (default: 32768 on POSIX hosts, 0 otherwise)</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-grow</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the multiplier used to increase the polling time when the algorithm detects it is missing events due to not polling long enough. 0 selects a default behaviour (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-shrink</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the divisor used to decrease the polling time when the algorithm detects it is spending too long polling without encountering events. 0 selects a default behaviour (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">aio-max-batch</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum number of requests in a batch for the AIO engine, 0 means that the engine will use its default (default:0, since 6.1)</dd> </dl> </div> <div class="section" id="qapidoc-2195"> <h4>Since<a class="headerlink" href="#qapidoc-2195" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-2200"> <h3><a class="toc-backref" href="#id376"><code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2200" title="Permalink to this headline">¶</a></h3> <p>Properties for objects of classes derived from memory-backend.</p> <div class="section" id="qapidoc-2197"> <h4>Members<a class="headerlink" href="#qapidoc-2197" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">merge</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, mark the memory as mergeable (default depends on the machine type)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dump</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, include the memory in core dumps (default depends on the machine type)</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-nodes</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd>the list of NUMA host nodes to bind the memory to</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">HostMemPolicy</span></code> (optional)</dt> <dd>the NUMA policy (default: ‘default’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">prealloc</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, preallocate memory (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">prealloc-threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of CPU threads to use for prealloc (default: 1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">share</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if false, the memory is private to QEMU; if true, it is shared (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reserve</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, reserve swap space (or huge pages) if applicable (default: true) (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of the memory region in bytes</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-use-canonical-path-for-ramblock-id</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the canoncial path is used for ramblock-id. Disable this for 4.0 machine types or older to allow migration with newer QEMU versions. (default: false generally, but true for machine types <= 4.0)</dd> </dl> </div> <div class="section" id="qapidoc-2198"> <h4>Note<a class="headerlink" href="#qapidoc-2198" title="Permalink to this headline">¶</a></h4> <p>prealloc=true and reserve=false cannot be set at the same time. With reserve=true, the behavior depends on the operating system: for example, Linux will not reserve swap space for shared file mappings – “not applicable”. In contrast, reserve=false will bail out if it cannot be configured accordingly.</p> </div> <div class="section" id="qapidoc-2199"> <h4>Since<a class="headerlink" href="#qapidoc-2199" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2203"> <h3><a class="toc-backref" href="#id377"><code class="docutils literal notranslate"><span class="pre">MemoryBackendFileProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2203" title="Permalink to this headline">¶</a></h3> <p>Properties for memory-backend-file objects.</p> <div class="section" id="qapidoc-2201"> <h4>Members<a class="headerlink" href="#qapidoc-2201" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">align</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the base address alignment when QEMU mmap(2)s <code class="docutils literal notranslate"><span class="pre">mem-path</span></code>. Some backend stores specified by <code class="docutils literal notranslate"><span class="pre">mem-path</span></code> require an alignment different than the default one used by QEMU, e.g. the device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In such cases, users can specify the required alignment via this option. 0 selects a default alignment (currently the page size). (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">discard-data</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the file contents can be destroyed when QEMU exits, to avoid unnecessarily flushing data to the backing file. Note that <code class="docutils literal notranslate"><span class="pre">discard-data</span></code> is only an optimization, and QEMU might not discard file contents if it aborts unexpectedly or is terminated using SIGKILL. (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">mem-path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path to either a shared memory or huge page filesystem mount</dd> <dt><code class="docutils literal notranslate"><span class="pre">pmem</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional) (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LIBPMEM</span></code>)</dt> <dd>specifies whether the backing file specified by <code class="docutils literal notranslate"><span class="pre">mem-path</span></code> is in host persistent memory that can be accessed using the SNIA NVM programming model (e.g. Intel NVDIMM).</dd> <dt><code class="docutils literal notranslate"><span class="pre">readonly</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the backing file is opened read-only; if false, it is opened read-write. (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code></dl> </div> <div class="section" id="qapidoc-2202"> <h4>Since<a class="headerlink" href="#qapidoc-2202" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2206"> <h3><a class="toc-backref" href="#id378"><code class="docutils literal notranslate"><span class="pre">MemoryBackendMemfdProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2206" title="Permalink to this headline">¶</a></h3> <p>Properties for memory-backend-memfd objects.</p> <p>The <code class="docutils literal notranslate"><span class="pre">share</span></code> boolean option is true by default with memfd.</p> <div class="section" id="qapidoc-2204"> <h4>Members<a class="headerlink" href="#qapidoc-2204" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">hugetlb</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the file to be created resides in the hugetlbfs filesystem (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">hugetlbsize</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the hugetlb page size on systems that support multiple hugetlb page sizes (it must be a power of 2 value supported by the system). 0 selects a default page size. This option is ignored if <code class="docutils literal notranslate"><span class="pre">hugetlb</span></code> is false. (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">seal</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, create a sealed-file, which will block further resizing of the memory (default: true)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code></dl> </div> <div class="section" id="qapidoc-2205"> <h4>Since<a class="headerlink" href="#qapidoc-2205" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2209"> <h3><a class="toc-backref" href="#id379"><code class="docutils literal notranslate"><span class="pre">MemoryBackendEpcProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2209" title="Permalink to this headline">¶</a></h3> <p>Properties for memory-backend-epc objects.</p> <p>The <code class="docutils literal notranslate"><span class="pre">share</span></code> boolean option is true by default with epc</p> <p>The <code class="docutils literal notranslate"><span class="pre">merge</span></code> boolean option is false by default with epc</p> <p>The <code class="docutils literal notranslate"><span class="pre">dump</span></code> boolean option is false by default with epc</p> <div class="section" id="qapidoc-2207"> <h4>Members<a class="headerlink" href="#qapidoc-2207" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code></dl> </div> <div class="section" id="qapidoc-2208"> <h4>Since<a class="headerlink" href="#qapidoc-2208" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2212"> <h3><a class="toc-backref" href="#id380"><code class="docutils literal notranslate"><span class="pre">PrManagerHelperProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2212" title="Permalink to this headline">¶</a></h3> <p>Properties for pr-manager-helper objects.</p> <div class="section" id="qapidoc-2210"> <h4>Members<a class="headerlink" href="#qapidoc-2210" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path to a Unix domain socket for connecting to the external helper</dd> </dl> </div> <div class="section" id="qapidoc-2211"> <h4>Since<a class="headerlink" href="#qapidoc-2211" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-2215"> <h3><a class="toc-backref" href="#id381"><code class="docutils literal notranslate"><span class="pre">QtestProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2215" title="Permalink to this headline">¶</a></h3> <p>Properties for qtest objects.</p> <div class="section" id="qapidoc-2213"> <h4>Members<a class="headerlink" href="#qapidoc-2213" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev to be used to receive qtest commands on.</dd> <dt><code class="docutils literal notranslate"><span class="pre">log</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the path to a log file</dd> </dl> </div> <div class="section" id="qapidoc-2214"> <h4>Since<a class="headerlink" href="#qapidoc-2214" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2218"> <h3><a class="toc-backref" href="#id382"><code class="docutils literal notranslate"><span class="pre">RemoteObjectProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2218" title="Permalink to this headline">¶</a></h3> <p>Properties for x-remote-object objects.</p> <div class="section" id="qapidoc-2216"> <h4>Members<a class="headerlink" href="#qapidoc-2216" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>file descriptor name previously passed via ‘getfd’ command</dd> <dt><code class="docutils literal notranslate"><span class="pre">devid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the id of the device to be associated with the file descriptor</dd> </dl> </div> <div class="section" id="qapidoc-2217"> <h4>Since<a class="headerlink" href="#qapidoc-2217" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2222"> <h3><a class="toc-backref" href="#id383"><code class="docutils literal notranslate"><span class="pre">RngProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2222" title="Permalink to this headline">¶</a></h3> <p>Properties for objects of classes derived from rng.</p> <div class="section" id="qapidoc-2219"> <h4>Members<a class="headerlink" href="#qapidoc-2219" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">opened</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, the device is opened immediately when applying this option and will probably fail when processing the next option. Don’t use; only provided for compatibility. (default: false)</dd> </dl> </div> <div class="section" id="qapidoc-2220"> <h4>Features<a class="headerlink" href="#qapidoc-2220" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">opened</span></code> is deprecated. Setting true doesn’t make sense, and false is already the default.</dd> </dl> </div> <div class="section" id="qapidoc-2221"> <h4>Since<a class="headerlink" href="#qapidoc-2221" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-2225"> <h3><a class="toc-backref" href="#id384"><code class="docutils literal notranslate"><span class="pre">RngEgdProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2225" title="Permalink to this headline">¶</a></h3> <p>Properties for rng-egd objects.</p> <div class="section" id="qapidoc-2223"> <h4>Members<a class="headerlink" href="#qapidoc-2223" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of a character device backend that provides the connection to the RNG daemon</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RngProperties</span></code></dl> </div> <div class="section" id="qapidoc-2224"> <h4>Since<a class="headerlink" href="#qapidoc-2224" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-2228"> <h3><a class="toc-backref" href="#id385"><code class="docutils literal notranslate"><span class="pre">RngRandomProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2228" title="Permalink to this headline">¶</a></h3> <p>Properties for rng-random objects.</p> <div class="section" id="qapidoc-2226"> <h4>Members<a class="headerlink" href="#qapidoc-2226" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the filename of the device on the host to obtain entropy from (default: “/dev/urandom”)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">RngProperties</span></code></dl> </div> <div class="section" id="qapidoc-2227"> <h4>Since<a class="headerlink" href="#qapidoc-2227" title="Permalink to this headline">¶</a></h4> <p>1.3</p> </div> </div> <div class="section" id="qapidoc-2231"> <h3><a class="toc-backref" href="#id386"><code class="docutils literal notranslate"><span class="pre">SevGuestProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2231" title="Permalink to this headline">¶</a></h3> <p>Properties for sev-guest objects.</p> <div class="section" id="qapidoc-2229"> <h4>Members<a class="headerlink" href="#qapidoc-2229" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sev-device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>SEV device to use (default: “/dev/sev”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dh-cert-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest owners DH certificate (encoded with base64)</dd> <dt><code class="docutils literal notranslate"><span class="pre">session-file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>guest owners session parameters (encoded with base64)</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>SEV policy value (default: 0x1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">handle</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>SEV firmware handle (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cbitpos</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>C-bit location in page table entry (default: 0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reduced-phys-bits</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of bits in physical addresses that become unavailable when SEV is enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">kernel-hashes</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if true, add hashes of kernel/initrd/cmdline to a designated guest firmware page for measured boot with -kernel (default: false) (since 6.2)</dd> </dl> </div> <div class="section" id="qapidoc-2230"> <h4>Since<a class="headerlink" href="#qapidoc-2230" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2235"> <h3><a class="toc-backref" href="#id387"><code class="docutils literal notranslate"><span class="pre">ObjectType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2235" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2232"> <h4>Values<a class="headerlink" href="#qapidoc-2232" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">authz-list</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">authz-listfile</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">authz-pam</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">authz-simple</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">can-bus</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">can-host-socketcan</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">colo-compare</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cryptodev-backend</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cryptodev-backend-builtin</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cryptodev-vhost-user</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_VHOST_CRYPTO</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">dbus-vmstate</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-buffer</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-dump</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-mirror</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-redirector</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-replay</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">filter-rewriter</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">input-barrier</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">input-linux</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">iothread</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory-backend-epc</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory-backend-file</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory-backend-memfd</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory-backend-ram</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pef-guest</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pr-manager-helper</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">qtest</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">rng-builtin</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">rng-egd</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">rng-random</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_POSIX</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">secret</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">secret_keyring</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SECRET_KEYRING</span></code>)</dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sev-guest</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">s390-pv-guest</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">throttle-group</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds-anon</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds-psk</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-creds-x509</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls-cipher-suites</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x-remote-object</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2233"> <h4>Features<a class="headerlink" href="#qapidoc-2233" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">x-remote-object</span></code> is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-2234"> <h4>Since<a class="headerlink" href="#qapidoc-2234" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2238"> <h3><a class="toc-backref" href="#id388"><code class="docutils literal notranslate"><span class="pre">ObjectOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2238" title="Permalink to this headline">¶</a></h3> <p>Describes the options of a user creatable QOM object.</p> <div class="section" id="qapidoc-2236"> <h4>Members<a class="headerlink" href="#qapidoc-2236" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">qom-type</span></code>: <code class="docutils literal notranslate"><span class="pre">ObjectType</span></code></dt> <dd>the class name for the object to be created</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the new object</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AuthZListProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"authz-list"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AuthZListFileProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"authz-listfile"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AuthZPAMProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"authz-pam"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AuthZSimpleProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"authz-simple"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">CanHostSocketcanProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"can-host-socketcan"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">ColoCompareProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"colo-compare"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"cryptodev-backend"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">CryptodevBackendProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"cryptodev-backend-builtin"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">CryptodevVhostUserProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"cryptodev-vhost-user"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_VHOST_CRYPTO</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">DBusVMStateProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"dbus-vmstate"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">FilterBufferProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-buffer"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">FilterDumpProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-dump"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">FilterMirrorProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-mirror"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">FilterRedirectorProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-redirector"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NetfilterProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-replay"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">FilterRewriterProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"filter-rewriter"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">InputBarrierProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"input-barrier"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">InputLinuxProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"input-linux"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">IothreadProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"iothread"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendEpcProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"memory-backend-epc"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendFileProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"memory-backend-file"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendMemfdProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"memory-backend-memfd"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">MemoryBackendProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"memory-backend-ram"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">PrManagerHelperProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"pr-manager-helper"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_LINUX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">QtestProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"qtest"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RngProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"rng-builtin"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RngEgdProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"rng-egd"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RngRandomProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"rng-random"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_POSIX</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">SecretProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"secret"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SecretKeyringProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"secret_keyring"</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">CONFIG_SECRET_KEYRING</span></code>)<dt>The members of <code class="docutils literal notranslate"><span class="pre">SevGuestProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"sev-guest"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">ThrottleGroupProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"throttle-group"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsAnonProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"tls-creds-anon"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsPskProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"tls-creds-psk"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsX509Properties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"tls-creds-x509"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">TlsCredsProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"tls-cipher-suites"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">RemoteObjectProperties</span></code> when <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is <code class="docutils literal notranslate"><span class="pre">"x-remote-object"</span></code></dl> </div> <div class="section" id="qapidoc-2237"> <h4>Since<a class="headerlink" href="#qapidoc-2237" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2243"> <h3><a class="toc-backref" href="#id389"><code class="docutils literal notranslate"><span class="pre">object-add</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2243" title="Permalink to this headline">¶</a></h3> <p>Create a QOM object.</p> <div class="section" id="qapidoc-2239"> <h4>Arguments<a class="headerlink" href="#qapidoc-2239" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">ObjectOptions</span></code></dl> </div> <div class="section" id="qapidoc-2240"> <h4>Returns<a class="headerlink" href="#qapidoc-2240" title="Permalink to this headline">¶</a></h4> <p>Nothing on success Error if <code class="docutils literal notranslate"><span class="pre">qom-type</span></code> is not a valid class name</p> </div> <div class="section" id="qapidoc-2241"> <h4>Since<a class="headerlink" href="#qapidoc-2241" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> <div class="section" id="qapidoc-2242"> <h4>Example<a class="headerlink" href="#qapidoc-2242" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"object-add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"qom-type"</span><span class="p">:</span> <span class="s2">"rng-random"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"rng1"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/dev/hwrng"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2248"> <h3><a class="toc-backref" href="#id390"><code class="docutils literal notranslate"><span class="pre">object-del</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2248" title="Permalink to this headline">¶</a></h3> <p>Remove a QOM object.</p> <div class="section" id="qapidoc-2244"> <h4>Arguments<a class="headerlink" href="#qapidoc-2244" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the QOM object to remove</dd> </dl> </div> <div class="section" id="qapidoc-2245"> <h4>Returns<a class="headerlink" href="#qapidoc-2245" title="Permalink to this headline">¶</a></h4> <p>Nothing on success Error if <code class="docutils literal notranslate"><span class="pre">id</span></code> is not a valid id for a QOM object</p> </div> <div class="section" id="qapidoc-2246"> <h4>Since<a class="headerlink" href="#qapidoc-2246" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> <div class="section" id="qapidoc-2247"> <h4>Example<a class="headerlink" href="#qapidoc-2247" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"object-del"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"rng1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2249"> <h2><a class="toc-backref" href="#id391">Device infrastructure (qdev)</a><a class="headerlink" href="#qapidoc-2249" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2254"> <h3><a class="toc-backref" href="#id392"><code class="docutils literal notranslate"><span class="pre">device-list-properties</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2254" title="Permalink to this headline">¶</a></h3> <p>List properties associated with a device.</p> <div class="section" id="qapidoc-2250"> <h4>Arguments<a class="headerlink" href="#qapidoc-2250" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">typename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the type name of a device</dd> </dl> </div> <div class="section" id="qapidoc-2251"> <h4>Returns<a class="headerlink" href="#qapidoc-2251" title="Permalink to this headline">¶</a></h4> <p>a list of ObjectPropertyInfo describing a devices properties</p> </div> <div class="section" id="qapidoc-2252"> <h4>Note<a class="headerlink" href="#qapidoc-2252" title="Permalink to this headline">¶</a></h4> <p>objects can create properties at runtime, for example to describe links between different devices and/or objects. These properties are not included in the output of this command.</p> </div> <div class="section" id="qapidoc-2253"> <h4>Since<a class="headerlink" href="#qapidoc-2253" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2261"> <h3><a class="toc-backref" href="#id393"><code class="docutils literal notranslate"><span class="pre">device_add</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2261" title="Permalink to this headline">¶</a></h3> <p>Add a device.</p> <div class="section" id="qapidoc-2255"> <h4>Arguments<a class="headerlink" href="#qapidoc-2255" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the new device’s driver</dd> <dt><code class="docutils literal notranslate"><span class="pre">bus</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the device’s parent bus (device tree path)</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the device’s ID, must be unique</dd> </dl> </div> <div class="section" id="qapidoc-2256"> <h4>Features<a class="headerlink" href="#qapidoc-2256" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">json-cli</span></code></dt> <dd>If present, the “-device” command line option supports JSON syntax with a structure identical to the arguments of this command.</dd> <dt><code class="docutils literal notranslate"><span class="pre">json-cli-hotplug</span></code></dt> <dd>If present, the “-device” command line option supports JSON syntax without the reference counting leak that broke hot-unplug</dd> </dl> </div> <div class="section" id="qapidoc-2257"> <h4>Notes<a class="headerlink" href="#qapidoc-2257" title="Permalink to this headline">¶</a></h4> <p>Additional arguments depend on the type.</p> <ol class="arabic simple"> <li>For detailed information about this command, please refer to the ‘docs/qdev-device-use.txt’ file.</li> <li>It’s possible to list device properties by running QEMU with the “-device DEVICE,help” command-line argument, where DEVICE is the device’s name</li> </ol> </div> <div class="section" id="qapidoc-2258"> <h4>Example<a class="headerlink" href="#qapidoc-2258" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"device_add"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"driver"</span><span class="p">:</span> <span class="s2">"e1000"</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"net1"</span><span class="p">,</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="s2">"pci.0"</span><span class="p">,</span> <span class="s2">"mac"</span><span class="p">:</span> <span class="s2">"52:54:00:12:34:56"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2259"> <h4>TODO<a class="headerlink" href="#qapidoc-2259" title="Permalink to this headline">¶</a></h4> <p>This command effectively bypasses QAPI completely due to its “additional arguments” business. It shouldn’t have been added to the schema in this form. It should be qapified properly, or replaced by a properly qapified command.</p> </div> <div class="section" id="qapidoc-2260"> <h4>Since<a class="headerlink" href="#qapidoc-2260" title="Permalink to this headline">¶</a></h4> <p>0.13</p> </div> </div> <div class="section" id="qapidoc-2267"> <h3><a class="toc-backref" href="#id394"><code class="docutils literal notranslate"><span class="pre">device_del</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2267" title="Permalink to this headline">¶</a></h3> <p>Remove a device from a guest</p> <div class="section" id="qapidoc-2262"> <h4>Arguments<a class="headerlink" href="#qapidoc-2262" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device’s ID or QOM path</dd> </dl> </div> <div class="section" id="qapidoc-2263"> <h4>Returns<a class="headerlink" href="#qapidoc-2263" title="Permalink to this headline">¶</a></h4> <p>Nothing on success If <code class="docutils literal notranslate"><span class="pre">id</span></code> is not a valid device, DeviceNotFound</p> </div> <div class="section" id="qapidoc-2264"> <h4>Notes<a class="headerlink" href="#qapidoc-2264" title="Permalink to this headline">¶</a></h4> <p>When this command completes, the device may not be removed from the guest. Hot removal is an operation that requires guest cooperation. This command merely requests that the guest begin the hot removal process. Completion of the device removal process is signaled with a DEVICE_DELETED event. Guest reset will automatically complete removal for all devices. If a guest-side error in the hot removal process is detected, the device will not be removed and a DEVICE_UNPLUG_GUEST_ERROR event is sent. Some errors cannot be detected.</p> </div> <div class="section" id="qapidoc-2265"> <h4>Since<a class="headerlink" href="#qapidoc-2265" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2266"> <h4>Example<a class="headerlink" href="#qapidoc-2266" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"device_del"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"net1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"device_del"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"/machine/peripheral-anon/device[0]"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2271"> <h3><a class="toc-backref" href="#id395"><code class="docutils literal notranslate"><span class="pre">DEVICE_DELETED</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2271" title="Permalink to this headline">¶</a></h3> <p>Emitted whenever the device removal completion is acknowledged by the guest. At this point, it’s safe to reuse the specified device ID. Device removal can be initiated by the guest or by HMP/QMP commands.</p> <div class="section" id="qapidoc-2268"> <h4>Arguments<a class="headerlink" href="#qapidoc-2268" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the device’s ID if it has one</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device’s QOM path</dd> </dl> </div> <div class="section" id="qapidoc-2269"> <h4>Since<a class="headerlink" href="#qapidoc-2269" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-2270"> <h4>Example<a class="headerlink" href="#qapidoc-2270" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_DELETED"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"virtio-net-pci-0"</span><span class="p">,</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/machine/peripheral/virtio-net-pci-0"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2275"> <h3><a class="toc-backref" href="#id396"><code class="docutils literal notranslate"><span class="pre">DEVICE_UNPLUG_GUEST_ERROR</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2275" title="Permalink to this headline">¶</a></h3> <p>Emitted when a device hot unplug fails due to a guest reported error.</p> <div class="section" id="qapidoc-2272"> <h4>Arguments<a class="headerlink" href="#qapidoc-2272" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the device’s ID if it has one</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device’s QOM path</dd> </dl> </div> <div class="section" id="qapidoc-2273"> <h4>Since<a class="headerlink" href="#qapidoc-2273" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2274"> <h4>Example<a class="headerlink" href="#qapidoc-2274" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"DEVICE_UNPLUG_GUEST_ERROR"</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"core1"</span><span class="p">,</span> <span class="s2">"path"</span><span class="p">:</span> <span class="s2">"/machine/peripheral/core1"</span> <span class="p">},</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1615570772</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">202844</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2276"> <h2><a class="toc-backref" href="#id397">Machines</a><a class="headerlink" href="#qapidoc-2276" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2280"> <h3><a class="toc-backref" href="#id398"><code class="docutils literal notranslate"><span class="pre">SysEmuTarget</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2280" title="Permalink to this headline">¶</a></h3> <p>The comprehensive enumeration of QEMU system emulation (“softmmu”) targets. Run “./configure –help” in the project root directory, and look for the *-softmmu targets near the “–target-list” option. The individual target constants are not documented here, for the time being.</p> <div class="section" id="qapidoc-2277"> <h4>Values<a class="headerlink" href="#qapidoc-2277" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">rx</span></code></dt> <dd>since 5.0</dd> <dt><code class="docutils literal notranslate"><span class="pre">avr</span></code></dt> <dd>since 5.1</dd> <dt><code class="docutils literal notranslate"><span class="pre">aarch64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">alpha</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">arm</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">cris</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">hppa</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">i386</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">m68k</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">microblaze</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">microblazeel</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">mips</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">mips64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">mips64el</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">mipsel</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">nios2</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">or1k</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ppc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ppc64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">riscv32</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">riscv64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">s390x</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sh4</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sh4eb</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sparc</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sparc64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">tricore</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">x86_64</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">xtensa</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">xtensaeb</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2278"> <h4>Notes<a class="headerlink" href="#qapidoc-2278" title="Permalink to this headline">¶</a></h4> <p>The resulting QMP strings can be appended to the “qemu-system-” prefix to produce the corresponding QEMU executable name. This is true even for “qemu-system-x86_64”.</p> </div> <div class="section" id="qapidoc-2279"> <h4>Since<a class="headerlink" href="#qapidoc-2279" title="Permalink to this headline">¶</a></h4> <p>3.0</p> </div> </div> <div class="section" id="qapidoc-2283"> <h3><a class="toc-backref" href="#id399"><code class="docutils literal notranslate"><span class="pre">CpuS390State</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2283" title="Permalink to this headline">¶</a></h3> <p>An enumeration of cpu states that can be assumed by a virtual S390 CPU</p> <div class="section" id="qapidoc-2281"> <h4>Values<a class="headerlink" href="#qapidoc-2281" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">uninitialized</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">stopped</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">check-stop</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">operating</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">load</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2282"> <h4>Since<a class="headerlink" href="#qapidoc-2282" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2286"> <h3><a class="toc-backref" href="#id400"><code class="docutils literal notranslate"><span class="pre">CpuInfoS390</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2286" title="Permalink to this headline">¶</a></h3> <p>Additional information about a virtual S390 CPU</p> <div class="section" id="qapidoc-2284"> <h4>Members<a class="headerlink" href="#qapidoc-2284" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cpu-state</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuS390State</span></code></dt> <dd>the virtual CPU’s state</dd> </dl> </div> <div class="section" id="qapidoc-2285"> <h4>Since<a class="headerlink" href="#qapidoc-2285" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2289"> <h3><a class="toc-backref" href="#id401"><code class="docutils literal notranslate"><span class="pre">CpuInfoFast</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2289" title="Permalink to this headline">¶</a></h3> <p>Information about a virtual CPU</p> <div class="section" id="qapidoc-2287"> <h4>Members<a class="headerlink" href="#qapidoc-2287" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cpu-index</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>index of the virtual CPU</dd> <dt><code class="docutils literal notranslate"><span class="pre">qom-path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>path to the CPU object in the QOM tree</dd> <dt><code class="docutils literal notranslate"><span class="pre">thread-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>ID of the underlying host thread</dd> <dt><code class="docutils literal notranslate"><span class="pre">props</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code> (optional)</dt> <dd>properties describing to which node/socket/core/thread virtual CPU belongs to, provided if supported by board</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">SysEmuTarget</span></code></dt> <dd>the QEMU system emulation target, which determines which additional fields will be listed (since 3.0)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">CpuInfoS390</span></code> when <code class="docutils literal notranslate"><span class="pre">target</span></code> is <code class="docutils literal notranslate"><span class="pre">"s390x"</span></code></dl> </div> <div class="section" id="qapidoc-2288"> <h4>Since<a class="headerlink" href="#qapidoc-2288" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> </div> <div class="section" id="qapidoc-2293"> <h3><a class="toc-backref" href="#id402"><code class="docutils literal notranslate"><span class="pre">query-cpus-fast</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2293" title="Permalink to this headline">¶</a></h3> <p>Returns information about all virtual CPUs.</p> <div class="section" id="qapidoc-2290"> <h4>Returns<a class="headerlink" href="#qapidoc-2290" title="Permalink to this headline">¶</a></h4> <p>list of <code class="docutils literal notranslate"><span class="pre">CpuInfoFast</span></code></p> </div> <div class="section" id="qapidoc-2291"> <h4>Since<a class="headerlink" href="#qapidoc-2291" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2292"> <h4>Example<a class="headerlink" href="#qapidoc-2292" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-cpus-fast"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">25627</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"socket-id"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="s2">"qom-path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[0]"</span><span class="p">,</span> <span class="s2">"arch"</span><span class="p">:</span><span class="s2">"x86"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span><span class="s2">"x86_64"</span><span class="p">,</span> <span class="s2">"cpu-index"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">25628</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"socket-id"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span> <span class="s2">"qom-path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[2]"</span><span class="p">,</span> <span class="s2">"arch"</span><span class="p">:</span><span class="s2">"x86"</span><span class="p">,</span> <span class="s2">"target"</span><span class="p">:</span><span class="s2">"x86_64"</span><span class="p">,</span> <span class="s2">"cpu-index"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2296"> <h3><a class="toc-backref" href="#id403"><code class="docutils literal notranslate"><span class="pre">MachineInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2296" title="Permalink to this headline">¶</a></h3> <p>Information describing a machine.</p> <div class="section" id="qapidoc-2294"> <h4>Members<a class="headerlink" href="#qapidoc-2294" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the machine</dd> <dt><code class="docutils literal notranslate"><span class="pre">alias</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>an alias for the machine name</dd> <dt><code class="docutils literal notranslate"><span class="pre">is-default</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether the machine is default</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-max</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum number of CPUs supported by the machine type (since 1.5)</dd> <dt><code class="docutils literal notranslate"><span class="pre">hotpluggable-cpus</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>cpu hotplug via -device is supported (since 2.7)</dd> <dt><code class="docutils literal notranslate"><span class="pre">numa-mem-supported</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if ‘-numa node,mem’ option is supported by the machine type and false otherwise (since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>if true, the machine type is deprecated and may be removed in future versions of QEMU according to the QEMU deprecation policy (since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">default-cpu-type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>default CPU model typename if none is requested via the -cpu argument. (since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">default-ram-id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the default ID of initial RAM memory backend (since 5.2)</dd> </dl> </div> <div class="section" id="qapidoc-2295"> <h4>Since<a class="headerlink" href="#qapidoc-2295" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2299"> <h3><a class="toc-backref" href="#id404"><code class="docutils literal notranslate"><span class="pre">query-machines</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2299" title="Permalink to this headline">¶</a></h3> <p>Return a list of supported machines</p> <div class="section" id="qapidoc-2297"> <h4>Returns<a class="headerlink" href="#qapidoc-2297" title="Permalink to this headline">¶</a></h4> <p>a list of MachineInfo</p> </div> <div class="section" id="qapidoc-2298"> <h4>Since<a class="headerlink" href="#qapidoc-2298" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2302"> <h3><a class="toc-backref" href="#id405"><code class="docutils literal notranslate"><span class="pre">CurrentMachineParams</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2302" title="Permalink to this headline">¶</a></h3> <p>Information describing the running machine parameters.</p> <div class="section" id="qapidoc-2300"> <h4>Members<a class="headerlink" href="#qapidoc-2300" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">wakeup-suspend-support</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if the machine supports wake up from suspend</dd> </dl> </div> <div class="section" id="qapidoc-2301"> <h4>Since<a class="headerlink" href="#qapidoc-2301" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2305"> <h3><a class="toc-backref" href="#id406"><code class="docutils literal notranslate"><span class="pre">query-current-machine</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2305" title="Permalink to this headline">¶</a></h3> <p>Return information on the current virtual machine.</p> <div class="section" id="qapidoc-2303"> <h4>Returns<a class="headerlink" href="#qapidoc-2303" title="Permalink to this headline">¶</a></h4> <p>CurrentMachineParams</p> </div> <div class="section" id="qapidoc-2304"> <h4>Since<a class="headerlink" href="#qapidoc-2304" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2308"> <h3><a class="toc-backref" href="#id407"><code class="docutils literal notranslate"><span class="pre">TargetInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2308" title="Permalink to this headline">¶</a></h3> <p>Information describing the QEMU target.</p> <div class="section" id="qapidoc-2306"> <h4>Members<a class="headerlink" href="#qapidoc-2306" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">arch</span></code>: <code class="docutils literal notranslate"><span class="pre">SysEmuTarget</span></code></dt> <dd>the target architecture</dd> </dl> </div> <div class="section" id="qapidoc-2307"> <h4>Since<a class="headerlink" href="#qapidoc-2307" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2311"> <h3><a class="toc-backref" href="#id408"><code class="docutils literal notranslate"><span class="pre">query-target</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2311" title="Permalink to this headline">¶</a></h3> <p>Return information about the target for this QEMU</p> <div class="section" id="qapidoc-2309"> <h4>Returns<a class="headerlink" href="#qapidoc-2309" title="Permalink to this headline">¶</a></h4> <p>TargetInfo</p> </div> <div class="section" id="qapidoc-2310"> <h4>Since<a class="headerlink" href="#qapidoc-2310" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2315"> <h3><a class="toc-backref" href="#id409"><code class="docutils literal notranslate"><span class="pre">UuidInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2315" title="Permalink to this headline">¶</a></h3> <p>Guest UUID information (Universally Unique Identifier).</p> <div class="section" id="qapidoc-2312"> <h4>Members<a class="headerlink" href="#qapidoc-2312" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">UUID</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the UUID of the guest</dd> </dl> </div> <div class="section" id="qapidoc-2313"> <h4>Since<a class="headerlink" href="#qapidoc-2313" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2314"> <h4>Notes<a class="headerlink" href="#qapidoc-2314" title="Permalink to this headline">¶</a></h4> <p>If no UUID was specified for the guest, a null UUID is returned.</p> </div> </div> <div class="section" id="qapidoc-2319"> <h3><a class="toc-backref" href="#id410"><code class="docutils literal notranslate"><span class="pre">query-uuid</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2319" title="Permalink to this headline">¶</a></h3> <p>Query the guest UUID information.</p> <div class="section" id="qapidoc-2316"> <h4>Returns<a class="headerlink" href="#qapidoc-2316" title="Permalink to this headline">¶</a></h4> <p>The <code class="docutils literal notranslate"><span class="pre">UuidInfo</span></code> for the guest</p> </div> <div class="section" id="qapidoc-2317"> <h4>Since<a class="headerlink" href="#qapidoc-2317" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2318"> <h4>Example<a class="headerlink" href="#qapidoc-2318" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-uuid"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"UUID"</span><span class="p">:</span> <span class="s2">"550e8400-e29b-41d4-a716-446655440000"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2322"> <h3><a class="toc-backref" href="#id411"><code class="docutils literal notranslate"><span class="pre">GuidInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2322" title="Permalink to this headline">¶</a></h3> <p>GUID information.</p> <div class="section" id="qapidoc-2320"> <h4>Members<a class="headerlink" href="#qapidoc-2320" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">guid</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the globally unique identifier</dd> </dl> </div> <div class="section" id="qapidoc-2321"> <h4>Since<a class="headerlink" href="#qapidoc-2321" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-2324"> <h3><a class="toc-backref" href="#id412"><code class="docutils literal notranslate"><span class="pre">query-vm-generation-id</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2324" title="Permalink to this headline">¶</a></h3> <p>Show Virtual Machine Generation ID</p> <div class="section" id="qapidoc-2323"> <h4>Since<a class="headerlink" href="#qapidoc-2323" title="Permalink to this headline">¶</a></h4> <p>2.9</p> </div> </div> <div class="section" id="qapidoc-2327"> <h3><a class="toc-backref" href="#id413"><code class="docutils literal notranslate"><span class="pre">system_reset</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2327" title="Permalink to this headline">¶</a></h3> <p>Performs a hard reset of a guest.</p> <div class="section" id="qapidoc-2325"> <h4>Since<a class="headerlink" href="#qapidoc-2325" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2326"> <h4>Example<a class="headerlink" href="#qapidoc-2326" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"system_reset"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2331"> <h3><a class="toc-backref" href="#id414"><code class="docutils literal notranslate"><span class="pre">system_powerdown</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2331" title="Permalink to this headline">¶</a></h3> <p>Requests that a guest perform a powerdown operation.</p> <div class="section" id="qapidoc-2328"> <h4>Since<a class="headerlink" href="#qapidoc-2328" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2329"> <h4>Notes<a class="headerlink" href="#qapidoc-2329" title="Permalink to this headline">¶</a></h4> <p>A guest may or may not respond to this command. This command returning does not indicate that a guest has accepted the request or that it has shut down. Many guests will respond to this command by prompting the user in some way.</p> </div> <div class="section" id="qapidoc-2330"> <h4>Example<a class="headerlink" href="#qapidoc-2330" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"system_powerdown"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2336"> <h3><a class="toc-backref" href="#id415"><code class="docutils literal notranslate"><span class="pre">system_wakeup</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2336" title="Permalink to this headline">¶</a></h3> <p>Wake up guest from suspend. If the guest has wake-up from suspend support enabled (wakeup-suspend-support flag from query-current-machine), wake-up guest from suspend if the guest is in SUSPENDED state. Return an error otherwise.</p> <div class="section" id="qapidoc-2332"> <h4>Since<a class="headerlink" href="#qapidoc-2332" title="Permalink to this headline">¶</a></h4> <p>1.1</p> </div> <div class="section" id="qapidoc-2333"> <h4>Returns<a class="headerlink" href="#qapidoc-2333" title="Permalink to this headline">¶</a></h4> <p>nothing.</p> </div> <div class="section" id="qapidoc-2334"> <h4>Note<a class="headerlink" href="#qapidoc-2334" title="Permalink to this headline">¶</a></h4> <p>prior to 4.0, this command does nothing in case the guest isn’t suspended.</p> </div> <div class="section" id="qapidoc-2335"> <h4>Example<a class="headerlink" href="#qapidoc-2335" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"system_wakeup"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2339"> <h3><a class="toc-backref" href="#id416"><code class="docutils literal notranslate"><span class="pre">LostTickPolicy</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2339" title="Permalink to this headline">¶</a></h3> <p>Policy for handling lost ticks in timer devices. Ticks end up getting lost when, for example, the guest is paused.</p> <div class="section" id="qapidoc-2337"> <h4>Values<a class="headerlink" href="#qapidoc-2337" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">discard</span></code></dt> <dd>throw away the missed ticks and continue with future injection normally. The guest OS will see the timer jump ahead by a potentially quite significant amount all at once, as if the intervening chunk of time had simply not existed; needless to say, such a sudden jump can easily confuse a guest OS which is not specifically prepared to deal with it. Assuming the guest OS can deal correctly with the time jump, the time in the guest and in the host should now match.</dd> <dt><code class="docutils literal notranslate"><span class="pre">delay</span></code></dt> <dd>continue to deliver ticks at the normal rate. The guest OS will not notice anything is amiss, as from its point of view time will have continued to flow normally. The time in the guest should now be behind the time in the host by exactly the amount of time during which ticks have been missed.</dd> <dt><code class="docutils literal notranslate"><span class="pre">slew</span></code></dt> <dd>deliver ticks at a higher rate to catch up with the missed ticks. The guest OS will not notice anything is amiss, as from its point of view time will have continued to flow normally. Once the timer has managed to catch up with all the missing ticks, the time in the guest and in the host should match.</dd> </dl> </div> <div class="section" id="qapidoc-2338"> <h4>Since<a class="headerlink" href="#qapidoc-2338" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-2344"> <h3><a class="toc-backref" href="#id417"><code class="docutils literal notranslate"><span class="pre">inject-nmi</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2344" title="Permalink to this headline">¶</a></h3> <p>Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64). The command fails when the guest doesn’t support injecting.</p> <div class="section" id="qapidoc-2340"> <h4>Returns<a class="headerlink" href="#qapidoc-2340" title="Permalink to this headline">¶</a></h4> <p>If successful, nothing</p> </div> <div class="section" id="qapidoc-2341"> <h4>Since<a class="headerlink" href="#qapidoc-2341" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2342"> <h4>Note<a class="headerlink" href="#qapidoc-2342" title="Permalink to this headline">¶</a></h4> <p>prior to 2.1, this command was only supported for x86 and s390 VMs</p> </div> <div class="section" id="qapidoc-2343"> <h4>Example<a class="headerlink" href="#qapidoc-2343" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"inject-nmi"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2347"> <h3><a class="toc-backref" href="#id418"><code class="docutils literal notranslate"><span class="pre">KvmInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2347" title="Permalink to this headline">¶</a></h3> <p>Information about support for KVM acceleration</p> <div class="section" id="qapidoc-2345"> <h4>Members<a class="headerlink" href="#qapidoc-2345" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if KVM acceleration is active</dd> <dt><code class="docutils literal notranslate"><span class="pre">present</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if KVM acceleration is built into this executable</dd> </dl> </div> <div class="section" id="qapidoc-2346"> <h4>Since<a class="headerlink" href="#qapidoc-2346" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2351"> <h3><a class="toc-backref" href="#id419"><code class="docutils literal notranslate"><span class="pre">query-kvm</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2351" title="Permalink to this headline">¶</a></h3> <p>Returns information about KVM acceleration</p> <div class="section" id="qapidoc-2348"> <h4>Returns<a class="headerlink" href="#qapidoc-2348" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">KvmInfo</span></code></p> </div> <div class="section" id="qapidoc-2349"> <h4>Since<a class="headerlink" href="#qapidoc-2349" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2350"> <h4>Example<a class="headerlink" href="#qapidoc-2350" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-kvm"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"present"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2354"> <h3><a class="toc-backref" href="#id420"><code class="docutils literal notranslate"><span class="pre">NumaOptionsType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2354" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2352"> <h4>Values<a class="headerlink" href="#qapidoc-2352" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code></dt> <dd>NUMA nodes configuration</dd> <dt><code class="docutils literal notranslate"><span class="pre">dist</span></code></dt> <dd>NUMA distance configuration (since 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu</span></code></dt> <dd>property based CPU(s) to node mapping (Since: 2.10)</dd> <dt><code class="docutils literal notranslate"><span class="pre">hmat-lb</span></code></dt> <dd>memory latency and bandwidth information (Since: 5.0)</dd> <dt><code class="docutils literal notranslate"><span class="pre">hmat-cache</span></code></dt> <dd>memory side cache information (Since: 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-2353"> <h4>Since<a class="headerlink" href="#qapidoc-2353" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2357"> <h3><a class="toc-backref" href="#id421"><code class="docutils literal notranslate"><span class="pre">NumaOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2357" title="Permalink to this headline">¶</a></h3> <p>A discriminated record of NUMA options. (for OptsVisitor)</p> <div class="section" id="qapidoc-2355"> <h4>Members<a class="headerlink" href="#qapidoc-2355" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">NumaOptionsType</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaNodeOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"node"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaDistOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"dist"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaCpuOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"cpu"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaHmatLBOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"hmat-lb"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaHmatCacheOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"hmat-cache"</span></code></dl> </div> <div class="section" id="qapidoc-2356"> <h4>Since<a class="headerlink" href="#qapidoc-2356" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2360"> <h3><a class="toc-backref" href="#id422"><code class="docutils literal notranslate"><span class="pre">NumaNodeOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2360" title="Permalink to this headline">¶</a></h3> <p>Create a guest NUMA node. (for OptsVisitor)</p> <div class="section" id="qapidoc-2358"> <h4>Members<a class="headerlink" href="#qapidoc-2358" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">nodeid</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>NUMA node ID (increase by 1 from 0 if omitted)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpus</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code> (optional)</dt> <dd><dl class="first last docutils"> <dt>VCPUs belonging to this node (assign VCPUS round-robin</dt> <dd>if omitted)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">mem</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>memory size of this node; mutually exclusive with <code class="docutils literal notranslate"><span class="pre">memdev</span></code>. Equally divide total memory among nodes if both <code class="docutils literal notranslate"><span class="pre">mem</span></code> and <code class="docutils literal notranslate"><span class="pre">memdev</span></code> are omitted.</dd> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>memory backend object. If specified for one node, it must be specified for all nodes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">initiator</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>defined in ACPI 6.3 Chapter 5.2.27.3 Table 5-145, points to the nodeid which has the memory controller responsible for this NUMA node. This field provides additional information as to the initiator node that is closest (as in directly attached) to this node, and therefore has the best performance (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-2359"> <h4>Since<a class="headerlink" href="#qapidoc-2359" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2363"> <h3><a class="toc-backref" href="#id423"><code class="docutils literal notranslate"><span class="pre">NumaDistOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2363" title="Permalink to this headline">¶</a></h3> <p>Set the distance between 2 NUMA nodes.</p> <div class="section" id="qapidoc-2361"> <h4>Members<a class="headerlink" href="#qapidoc-2361" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">src</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>source NUMA node.</dd> <dt><code class="docutils literal notranslate"><span class="pre">dst</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>destination NUMA node.</dd> <dt><code class="docutils literal notranslate"><span class="pre">val</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>NUMA distance from source node to destination node. When a node is unreachable from another node, set the distance between them to 255.</dd> </dl> </div> <div class="section" id="qapidoc-2362"> <h4>Since<a class="headerlink" href="#qapidoc-2362" title="Permalink to this headline">¶</a></h4> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-2366"> <h3><a class="toc-backref" href="#id424"><code class="docutils literal notranslate"><span class="pre">X86CPURegister32</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2366" title="Permalink to this headline">¶</a></h3> <p>A X86 32-bit register</p> <div class="section" id="qapidoc-2364"> <h4>Values<a class="headerlink" href="#qapidoc-2364" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">EAX</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">EBX</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ECX</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">EDX</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ESP</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">EBP</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">ESI</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">EDI</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2365"> <h4>Since<a class="headerlink" href="#qapidoc-2365" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2369"> <h3><a class="toc-backref" href="#id425"><code class="docutils literal notranslate"><span class="pre">X86CPUFeatureWordInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2369" title="Permalink to this headline">¶</a></h3> <p>Information about a X86 CPU feature word</p> <div class="section" id="qapidoc-2367"> <h4>Members<a class="headerlink" href="#qapidoc-2367" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cpuid-input-eax</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Input EAX value for CPUID instruction for that feature word</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpuid-input-ecx</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>Input ECX value for CPUID instruction for that feature word</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpuid-register</span></code>: <code class="docutils literal notranslate"><span class="pre">X86CPURegister32</span></code></dt> <dd>Output register containing the feature bits</dd> <dt><code class="docutils literal notranslate"><span class="pre">features</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>value of output register, containing the feature bits</dd> </dl> </div> <div class="section" id="qapidoc-2368"> <h4>Since<a class="headerlink" href="#qapidoc-2368" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2372"> <h3><a class="toc-backref" href="#id426"><code class="docutils literal notranslate"><span class="pre">DummyForceArrays</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2372" title="Permalink to this headline">¶</a></h3> <p>Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally</p> <div class="section" id="qapidoc-2370"> <h4>Members<a class="headerlink" href="#qapidoc-2370" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unused</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">X86CPUFeatureWordInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2371"> <h4>Since<a class="headerlink" href="#qapidoc-2371" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2375"> <h3><a class="toc-backref" href="#id427"><code class="docutils literal notranslate"><span class="pre">NumaCpuOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2375" title="Permalink to this headline">¶</a></h3> <p>Option “-numa cpu” overrides default cpu to node mapping. It accepts the same set of cpu properties as returned by query-hotpluggable-cpus[].props, where node-id could be used to override default node mapping.</p> <div class="section" id="qapidoc-2373"> <h4>Members<a class="headerlink" href="#qapidoc-2373" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code></dl> </div> <div class="section" id="qapidoc-2374"> <h4>Since<a class="headerlink" href="#qapidoc-2374" title="Permalink to this headline">¶</a></h4> <p>2.10</p> </div> </div> <div class="section" id="qapidoc-2378"> <h3><a class="toc-backref" href="#id428"><code class="docutils literal notranslate"><span class="pre">HmatLBMemoryHierarchy</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2378" title="Permalink to this headline">¶</a></h3> <p>The memory hierarchy in the System Locality Latency and Bandwidth Information Structure of HMAT (Heterogeneous Memory Attribute Table)</p> <p>For more information about <code class="docutils literal notranslate"><span class="pre">HmatLBMemoryHierarchy</span></code>, see chapter 5.2.27.4: Table 5-146: Field “Flags” of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2376"> <h4>Values<a class="headerlink" href="#qapidoc-2376" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">memory</span></code></dt> <dd>the structure represents the memory performance</dd> <dt><code class="docutils literal notranslate"><span class="pre">first-level</span></code></dt> <dd>first level of memory side cache</dd> <dt><code class="docutils literal notranslate"><span class="pre">second-level</span></code></dt> <dd>second level of memory side cache</dd> <dt><code class="docutils literal notranslate"><span class="pre">third-level</span></code></dt> <dd>third level of memory side cache</dd> </dl> </div> <div class="section" id="qapidoc-2377"> <h4>Since<a class="headerlink" href="#qapidoc-2377" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2381"> <h3><a class="toc-backref" href="#id429"><code class="docutils literal notranslate"><span class="pre">HmatLBDataType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2381" title="Permalink to this headline">¶</a></h3> <p>Data type in the System Locality Latency and Bandwidth Information Structure of HMAT (Heterogeneous Memory Attribute Table)</p> <p>For more information about <code class="docutils literal notranslate"><span class="pre">HmatLBDataType</span></code>, see chapter 5.2.27.4: Table 5-146: Field “Data Type” of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2379"> <h4>Values<a class="headerlink" href="#qapidoc-2379" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">access-latency</span></code></dt> <dd>access latency (nanoseconds)</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-latency</span></code></dt> <dd>read latency (nanoseconds)</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-latency</span></code></dt> <dd>write latency (nanoseconds)</dd> <dt><code class="docutils literal notranslate"><span class="pre">access-bandwidth</span></code></dt> <dd>access bandwidth (Bytes per second)</dd> <dt><code class="docutils literal notranslate"><span class="pre">read-bandwidth</span></code></dt> <dd>read bandwidth (Bytes per second)</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-bandwidth</span></code></dt> <dd>write bandwidth (Bytes per second)</dd> </dl> </div> <div class="section" id="qapidoc-2380"> <h4>Since<a class="headerlink" href="#qapidoc-2380" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2384"> <h3><a class="toc-backref" href="#id430"><code class="docutils literal notranslate"><span class="pre">NumaHmatLBOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2384" title="Permalink to this headline">¶</a></h3> <p>Set the system locality latency and bandwidth information between Initiator and Target proximity Domains.</p> <p>For more information about <code class="docutils literal notranslate"><span class="pre">NumaHmatLBOptions</span></code>, see chapter 5.2.27.4: Table 5-146 of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2382"> <h4>Members<a class="headerlink" href="#qapidoc-2382" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">initiator</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the Initiator Proximity Domain.</dd> <dt><code class="docutils literal notranslate"><span class="pre">target</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the Target Proximity Domain.</dd> <dt><code class="docutils literal notranslate"><span class="pre">hierarchy</span></code>: <code class="docutils literal notranslate"><span class="pre">HmatLBMemoryHierarchy</span></code></dt> <dd>the Memory Hierarchy. Indicates the performance of memory or side cache.</dd> <dt><code class="docutils literal notranslate"><span class="pre">data-type</span></code>: <code class="docutils literal notranslate"><span class="pre">HmatLBDataType</span></code></dt> <dd>presents the type of data, access/read/write latency or hit latency.</dd> <dt><code class="docutils literal notranslate"><span class="pre">latency</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the value of latency from <code class="docutils literal notranslate"><span class="pre">initiator</span></code> to <code class="docutils literal notranslate"><span class="pre">target</span></code> proximity domain, the latency unit is “ns(nanosecond)”.</dd> <dt><code class="docutils literal notranslate"><span class="pre">bandwidth</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the value of bandwidth between <code class="docutils literal notranslate"><span class="pre">initiator</span></code> and <code class="docutils literal notranslate"><span class="pre">target</span></code> proximity domain, the bandwidth unit is “Bytes per second”.</dd> </dl> </div> <div class="section" id="qapidoc-2383"> <h4>Since<a class="headerlink" href="#qapidoc-2383" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2387"> <h3><a class="toc-backref" href="#id431"><code class="docutils literal notranslate"><span class="pre">HmatCacheAssociativity</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2387" title="Permalink to this headline">¶</a></h3> <p>Cache associativity in the Memory Side Cache Information Structure of HMAT</p> <p>For more information of <code class="docutils literal notranslate"><span class="pre">HmatCacheAssociativity</span></code>, see chapter 5.2.27.5: Table 5-147 of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2385"> <h4>Values<a class="headerlink" href="#qapidoc-2385" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd><dl class="first last docutils"> <dt>None (no memory side cache in this proximity domain,</dt> <dd>or cache associativity unknown)</dd> </dl> </dd> <dt><code class="docutils literal notranslate"><span class="pre">direct</span></code></dt> <dd>Direct Mapped</dd> <dt><code class="docutils literal notranslate"><span class="pre">complex</span></code></dt> <dd>Complex Cache Indexing (implementation specific)</dd> </dl> </div> <div class="section" id="qapidoc-2386"> <h4>Since<a class="headerlink" href="#qapidoc-2386" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2390"> <h3><a class="toc-backref" href="#id432"><code class="docutils literal notranslate"><span class="pre">HmatCacheWritePolicy</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2390" title="Permalink to this headline">¶</a></h3> <p>Cache write policy in the Memory Side Cache Information Structure of HMAT</p> <p>For more information of <code class="docutils literal notranslate"><span class="pre">HmatCacheWritePolicy</span></code>, see chapter 5.2.27.5: Table 5-147: Field “Cache Attributes” of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2388"> <h4>Values<a class="headerlink" href="#qapidoc-2388" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>None (no memory side cache in this proximity domain, or cache write policy unknown)</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-back</span></code></dt> <dd>Write Back (WB)</dd> <dt><code class="docutils literal notranslate"><span class="pre">write-through</span></code></dt> <dd>Write Through (WT)</dd> </dl> </div> <div class="section" id="qapidoc-2389"> <h4>Since<a class="headerlink" href="#qapidoc-2389" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2393"> <h3><a class="toc-backref" href="#id433"><code class="docutils literal notranslate"><span class="pre">NumaHmatCacheOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2393" title="Permalink to this headline">¶</a></h3> <p>Set the memory side cache information for a given memory domain.</p> <p>For more information of <code class="docutils literal notranslate"><span class="pre">NumaHmatCacheOptions</span></code>, see chapter 5.2.27.5: Table 5-147: Field “Cache Attributes” of ACPI 6.3 spec.</p> <div class="section" id="qapidoc-2391"> <h4>Members<a class="headerlink" href="#qapidoc-2391" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the memory proximity domain to which the memory belongs.</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the size of memory side cache in bytes.</dd> <dt><code class="docutils literal notranslate"><span class="pre">level</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the cache level described in this structure.</dd> <dt><code class="docutils literal notranslate"><span class="pre">associativity</span></code>: <code class="docutils literal notranslate"><span class="pre">HmatCacheAssociativity</span></code></dt> <dd>the cache associativity, none/direct-mapped/complex(complex cache indexing).</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">HmatCacheWritePolicy</span></code></dt> <dd>the write policy, none/write-back/write-through.</dd> <dt><code class="docutils literal notranslate"><span class="pre">line</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the cache Line size in bytes.</dd> </dl> </div> <div class="section" id="qapidoc-2392"> <h4>Since<a class="headerlink" href="#qapidoc-2392" title="Permalink to this headline">¶</a></h4> <p>5.0</p> </div> </div> <div class="section" id="qapidoc-2399"> <h3><a class="toc-backref" href="#id434"><code class="docutils literal notranslate"><span class="pre">memsave</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2399" title="Permalink to this headline">¶</a></h3> <p>Save a portion of guest memory to a file.</p> <div class="section" id="qapidoc-2394"> <h4>Arguments<a class="headerlink" href="#qapidoc-2394" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">val</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the virtual address of the guest to start from</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the size of memory region to save</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the file to save the memory to as binary data</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-index</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the index of the virtual CPU to use for translating the virtual address (defaults to CPU 0)</dd> </dl> </div> <div class="section" id="qapidoc-2395"> <h4>Returns<a class="headerlink" href="#qapidoc-2395" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-2396"> <h4>Since<a class="headerlink" href="#qapidoc-2396" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2397"> <h4>Notes<a class="headerlink" href="#qapidoc-2397" title="Permalink to this headline">¶</a></h4> <p>Errors were not reliably returned until 1.1</p> </div> <div class="section" id="qapidoc-2398"> <h4>Example<a class="headerlink" href="#qapidoc-2398" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"memsave"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"val"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/virtual-mem-dump"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2405"> <h3><a class="toc-backref" href="#id435"><code class="docutils literal notranslate"><span class="pre">pmemsave</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2405" title="Permalink to this headline">¶</a></h3> <p>Save a portion of guest physical memory to a file.</p> <div class="section" id="qapidoc-2400"> <h4>Arguments<a class="headerlink" href="#qapidoc-2400" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">val</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the physical address of the guest to start from</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the size of memory region to save</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the file to save the memory to as binary data</dd> </dl> </div> <div class="section" id="qapidoc-2401"> <h4>Returns<a class="headerlink" href="#qapidoc-2401" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-2402"> <h4>Since<a class="headerlink" href="#qapidoc-2402" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2403"> <h4>Notes<a class="headerlink" href="#qapidoc-2403" title="Permalink to this headline">¶</a></h4> <p>Errors were not reliably returned until 1.1</p> </div> <div class="section" id="qapidoc-2404"> <h4>Example<a class="headerlink" href="#qapidoc-2404" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"pmemsave"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"val"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/physical-mem-dump"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2408"> <h3><a class="toc-backref" href="#id436"><code class="docutils literal notranslate"><span class="pre">Memdev</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2408" title="Permalink to this headline">¶</a></h3> <p>Information about memory backend</p> <div class="section" id="qapidoc-2406"> <h4>Members<a class="headerlink" href="#qapidoc-2406" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>backend’s ID if backend has ‘id’ property (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>memory backend size</dd> <dt><code class="docutils literal notranslate"><span class="pre">merge</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether memory merge support is enabled</dd> <dt><code class="docutils literal notranslate"><span class="pre">dump</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether memory backend’s memory is included in a core dump</dd> <dt><code class="docutils literal notranslate"><span class="pre">prealloc</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether memory was preallocated</dd> <dt><code class="docutils literal notranslate"><span class="pre">share</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether memory is private to QEMU or shared (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">reserve</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether swap space (or huge pages) was reserved if applicable. This corresponds to the user configuration and not the actual behavior implemented in the OS to perform the reservation. For example, Linux will never reserve swap space for shared file mappings. (since 6.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">host-nodes</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">int</span></code></dt> <dd>host nodes for its memory policy</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">HostMemPolicy</span></code></dt> <dd>memory policy of memory backend</dd> </dl> </div> <div class="section" id="qapidoc-2407"> <h4>Since<a class="headerlink" href="#qapidoc-2407" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2412"> <h3><a class="toc-backref" href="#id437"><code class="docutils literal notranslate"><span class="pre">query-memdev</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2412" title="Permalink to this headline">¶</a></h3> <p>Returns information for all memory backends.</p> <div class="section" id="qapidoc-2409"> <h4>Returns<a class="headerlink" href="#qapidoc-2409" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">Memdev</span></code>.</p> </div> <div class="section" id="qapidoc-2410"> <h4>Since<a class="headerlink" href="#qapidoc-2410" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-2411"> <h4>Example<a class="headerlink" href="#qapidoc-2411" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-memdev"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"mem1"</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">536870912</span><span class="p">,</span> <span class="s2">"merge"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"dump"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"prealloc"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"host-nodes"</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="s2">"policy"</span><span class="p">:</span> <span class="s2">"bind"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">536870912</span><span class="p">,</span> <span class="s2">"merge"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"dump"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"prealloc"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"host-nodes"</span><span class="p">:</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="s2">"policy"</span><span class="p">:</span> <span class="s2">"preferred"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2416"> <h3><a class="toc-backref" href="#id438"><code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2416" title="Permalink to this headline">¶</a></h3> <p>List of properties to be used for hotplugging a CPU instance, it should be passed by management with device_add command when a CPU is being hotplugged.</p> <div class="section" id="qapidoc-2413"> <h4>Members<a class="headerlink" href="#qapidoc-2413" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>NUMA node ID the CPU belongs to</dd> <dt><code class="docutils literal notranslate"><span class="pre">socket-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>socket number within node/board the CPU belongs to</dd> <dt><code class="docutils literal notranslate"><span class="pre">die-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>die number within node/board the CPU belongs to (Since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">core-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>core number within die the CPU belongs to</dd> <dt><code class="docutils literal notranslate"><span class="pre">thread-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>thread number within core the CPU belongs to</dd> </dl> </div> <div class="section" id="qapidoc-2414"> <h4>Note<a class="headerlink" href="#qapidoc-2414" title="Permalink to this headline">¶</a></h4> <p>currently there are 5 properties that could be present but management should be prepared to pass through other properties with device_add command to allow for future interface extension. This also requires the filed names to be kept in sync with the properties passed to -device/device_add.</p> </div> <div class="section" id="qapidoc-2415"> <h4>Since<a class="headerlink" href="#qapidoc-2415" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-2419"> <h3><a class="toc-backref" href="#id439"><code class="docutils literal notranslate"><span class="pre">HotpluggableCPU</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2419" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2417"> <h4>Members<a class="headerlink" href="#qapidoc-2417" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>CPU object type for usage with device_add command</dd> <dt><code class="docutils literal notranslate"><span class="pre">props</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuInstanceProperties</span></code></dt> <dd>list of properties to be used for hotplugging CPU</dd> <dt><code class="docutils literal notranslate"><span class="pre">vcpus-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>number of logical VCPU threads <code class="docutils literal notranslate"><span class="pre">HotpluggableCPU</span></code> provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">qom-path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>link to existing CPU object if CPU is present or omitted if CPU is not present.</dd> </dl> </div> <div class="section" id="qapidoc-2418"> <h4>Since<a class="headerlink" href="#qapidoc-2418" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> </div> <div class="section" id="qapidoc-2424"> <h3><a class="toc-backref" href="#id440"><code class="docutils literal notranslate"><span class="pre">query-hotpluggable-cpus</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2424" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2420"> <h4>TODO<a class="headerlink" href="#qapidoc-2420" title="Permalink to this headline">¶</a></h4> <p>Better documentation; currently there is none.</p> </div> <div class="section" id="qapidoc-2421"> <h4>Returns<a class="headerlink" href="#qapidoc-2421" title="Permalink to this headline">¶</a></h4> <p>a list of HotpluggableCPU objects.</p> </div> <div class="section" id="qapidoc-2422"> <h4>Since<a class="headerlink" href="#qapidoc-2422" title="Permalink to this headline">¶</a></h4> <p>2.7</p> </div> <div class="section" id="qapidoc-2423"> <h4>Example<a class="headerlink" href="#qapidoc-2423" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">For</span> <span class="n">pseries</span> <span class="n">machine</span> <span class="nb">type</span> <span class="n">started</span> <span class="k">with</span> <span class="o">-</span><span class="n">smp</span> <span class="mi">2</span><span class="p">,</span><span class="n">cores</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span><span class="n">maxcpus</span><span class="o">=</span><span class="mi">4</span> <span class="o">-</span><span class="n">cpu</span> <span class="n">POWER8</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-hotpluggable-cpus"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core"</span><span class="p">:</span> <span class="mi">8</span> <span class="p">},</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"POWER8-spapr-cpu-core"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">},</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"POWER8-spapr-cpu-core"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"qom-path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[0]"</span><span class="p">}</span> <span class="p">]}</span><span class="s1">'</span> <span class="n">For</span> <span class="n">pc</span> <span class="n">machine</span> <span class="nb">type</span> <span class="n">started</span> <span class="k">with</span> <span class="o">-</span><span class="n">smp</span> <span class="mi">1</span><span class="p">,</span><span class="n">maxcpus</span><span class="o">=</span><span class="mi">2</span><span class="p">:</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-hotpluggable-cpus"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qemu64-x86_64-cpu"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"socket-id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"qom-path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[0]"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qemu64-x86_64-cpu"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"socket-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span> <span class="p">}</span> <span class="p">]}</span> <span class="n">For</span> <span class="n">s390x</span><span class="o">-</span><span class="n">virtio</span><span class="o">-</span><span class="n">ccw</span> <span class="n">machine</span> <span class="nb">type</span> <span class="n">started</span> <span class="k">with</span> <span class="o">-</span><span class="n">smp</span> <span class="mi">1</span><span class="p">,</span><span class="n">maxcpus</span><span class="o">=</span><span class="mi">2</span> <span class="o">-</span><span class="n">cpu</span> <span class="n">qemu</span> <span class="p">(</span><span class="n">Since</span><span class="p">:</span> <span class="mf">2.11</span><span class="p">):</span> <span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-hotpluggable-cpus"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span><span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qemu-s390x-cpu"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"qom-path"</span><span class="p">:</span> <span class="s2">"/machine/unattached/device[0]"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"qemu-s390x-cpu"</span><span class="p">,</span> <span class="s2">"vcpus-count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"props"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"core-id"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">}</span> <span class="p">]}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2426"> <h3><a class="toc-backref" href="#id441"><code class="docutils literal notranslate"><span class="pre">set-numa-node</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2426" title="Permalink to this headline">¶</a></h3> <p>Runtime equivalent of ‘-numa’ CLI option, available at preconfigure stage to configure numa mapping before initializing machine.</p> <p>Since 3.0</p> <div class="section" id="qapidoc-2425"> <h4>Arguments<a class="headerlink" href="#qapidoc-2425" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt>The members of <code class="docutils literal notranslate"><span class="pre">NumaOptions</span></code></dl> </div> </div> <div class="section" id="qapidoc-2432"> <h3><a class="toc-backref" href="#id442"><code class="docutils literal notranslate"><span class="pre">balloon</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2432" title="Permalink to this headline">¶</a></h3> <p>Request the balloon driver to change its balloon size.</p> <div class="section" id="qapidoc-2427"> <h4>Arguments<a class="headerlink" href="#qapidoc-2427" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">value</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd><p class="first">the target logical size of the VM in bytes. We can deduce the size of the balloon using this formula:</p> <blockquote> <div>logical_vm_size = vm_ram_size - balloon_size</div></blockquote> <p class="last">From it we have: balloon_size = vm_ram_size - <code class="docutils literal notranslate"><span class="pre">value</span></code></p> </dd> </dl> </div> <div class="section" id="qapidoc-2428"> <h4>Returns<a class="headerlink" href="#qapidoc-2428" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li>If the balloon driver is enabled but not functional because the KVM kernel module cannot support it, KvmMissingCap</li> <li>If no balloon device is present, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-2429"> <h4>Notes<a class="headerlink" href="#qapidoc-2429" title="Permalink to this headline">¶</a></h4> <p>This command just issues a request to the guest. When it returns, the balloon size may not have changed. A guest can change the balloon size independent of this command.</p> </div> <div class="section" id="qapidoc-2430"> <h4>Since<a class="headerlink" href="#qapidoc-2430" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2431"> <h4>Example<a class="headerlink" href="#qapidoc-2431" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"balloon"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"value"</span><span class="p">:</span> <span class="mi">536870912</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> <span class="n">With</span> <span class="n">a</span> <span class="mf">2.5</span><span class="n">GiB</span> <span class="n">guest</span> <span class="n">this</span> <span class="n">command</span> <span class="n">inflated</span> <span class="n">the</span> <span class="n">ballon</span> <span class="n">to</span> <span class="mi">3</span><span class="n">GiB</span><span class="o">.</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2435"> <h3><a class="toc-backref" href="#id443"><code class="docutils literal notranslate"><span class="pre">BalloonInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2435" title="Permalink to this headline">¶</a></h3> <p>Information about the guest balloon device.</p> <div class="section" id="qapidoc-2433"> <h4>Members<a class="headerlink" href="#qapidoc-2433" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">actual</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the logical size of the VM in bytes Formula used: logical_vm_size = vm_ram_size - balloon_size</dd> </dl> </div> <div class="section" id="qapidoc-2434"> <h4>Since<a class="headerlink" href="#qapidoc-2434" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2439"> <h3><a class="toc-backref" href="#id444"><code class="docutils literal notranslate"><span class="pre">query-balloon</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2439" title="Permalink to this headline">¶</a></h3> <p>Return information about the balloon device.</p> <div class="section" id="qapidoc-2436"> <h4>Returns<a class="headerlink" href="#qapidoc-2436" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li><code class="docutils literal notranslate"><span class="pre">BalloonInfo</span></code> on success</li> <li>If the balloon driver is enabled but not functional because the KVM kernel module cannot support it, KvmMissingCap</li> <li>If no balloon device is present, DeviceNotActive</li> </ul> </div> <div class="section" id="qapidoc-2437"> <h4>Since<a class="headerlink" href="#qapidoc-2437" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2438"> <h4>Example<a class="headerlink" href="#qapidoc-2438" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-balloon"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"actual"</span><span class="p">:</span> <span class="mi">1073741824</span><span class="p">,</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2444"> <h3><a class="toc-backref" href="#id445"><code class="docutils literal notranslate"><span class="pre">BALLOON_CHANGE</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2444" title="Permalink to this headline">¶</a></h3> <p>Emitted when the guest changes the actual BALLOON level. This value is equivalent to the <code class="docutils literal notranslate"><span class="pre">actual</span></code> field return by the ‘query-balloon’ command</p> <div class="section" id="qapidoc-2440"> <h4>Arguments<a class="headerlink" href="#qapidoc-2440" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">actual</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the logical size of the VM in bytes Formula used: logical_vm_size = vm_ram_size - balloon_size</dd> </dl> </div> <div class="section" id="qapidoc-2441"> <h4>Note<a class="headerlink" href="#qapidoc-2441" title="Permalink to this headline">¶</a></h4> <p>this event is rate-limited.</p> </div> <div class="section" id="qapidoc-2442"> <h4>Since<a class="headerlink" href="#qapidoc-2442" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2443"> <h4>Example<a class="headerlink" href="#qapidoc-2443" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"BALLOON_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"actual"</span><span class="p">:</span> <span class="mi">944766976</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267020223</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">435656</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2447"> <h3><a class="toc-backref" href="#id446"><code class="docutils literal notranslate"><span class="pre">MemoryInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2447" title="Permalink to this headline">¶</a></h3> <p>Actual memory information in bytes.</p> <div class="section" id="qapidoc-2445"> <h4>Members<a class="headerlink" href="#qapidoc-2445" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">base-memory</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of “base” memory specified with command line option -m.</dd> <dt><code class="docutils literal notranslate"><span class="pre">plugged-memory</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>size of memory that can be hot-unplugged. This field is omitted if target doesn’t support memory hotplug (i.e. CONFIG_MEM_DEVICE not defined at build time).</dd> </dl> </div> <div class="section" id="qapidoc-2446"> <h4>Since<a class="headerlink" href="#qapidoc-2446" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-2450"> <h3><a class="toc-backref" href="#id447"><code class="docutils literal notranslate"><span class="pre">query-memory-size-summary</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2450" title="Permalink to this headline">¶</a></h3> <p>Return the amount of initially allocated and present hotpluggable (if enabled) memory in bytes.</p> <div class="section" id="qapidoc-2448"> <h4>Example<a class="headerlink" href="#qapidoc-2448" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-memory-size-summary"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"base-memory"</span><span class="p">:</span> <span class="mi">4294967296</span><span class="p">,</span> <span class="s2">"plugged-memory"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2449"> <h4>Since<a class="headerlink" href="#qapidoc-2449" title="Permalink to this headline">¶</a></h4> <p>2.11</p> </div> </div> <div class="section" id="qapidoc-2453"> <h3><a class="toc-backref" href="#id448"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2453" title="Permalink to this headline">¶</a></h3> <p>PCDIMMDevice state information</p> <div class="section" id="qapidoc-2451"> <h4>Members<a class="headerlink" href="#qapidoc-2451" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device’s ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">addr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>physical address, where device is mapped</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">slot</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>slot number at which device is plugged in</dd> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>NUMA node number where device is plugged in</dd> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>memory backend linked with device</dd> <dt><code class="docutils literal notranslate"><span class="pre">hotplugged</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if device was hotplugged</dd> <dt><code class="docutils literal notranslate"><span class="pre">hotpluggable</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if device if could be added/removed while machine is running</dd> </dl> </div> <div class="section" id="qapidoc-2452"> <h4>Since<a class="headerlink" href="#qapidoc-2452" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2456"> <h3><a class="toc-backref" href="#id449"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2456" title="Permalink to this headline">¶</a></h3> <p>VirtioPMEM state information</p> <div class="section" id="qapidoc-2454"> <h4>Members<a class="headerlink" href="#qapidoc-2454" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device’s ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">memaddr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>physical address in memory, where device is mapped</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>memory backend linked with device</dd> </dl> </div> <div class="section" id="qapidoc-2455"> <h4>Since<a class="headerlink" href="#qapidoc-2455" title="Permalink to this headline">¶</a></h4> <p>4.1</p> </div> </div> <div class="section" id="qapidoc-2459"> <h3><a class="toc-backref" href="#id450"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2459" title="Permalink to this headline">¶</a></h3> <p>VirtioMEMDevice state information</p> <div class="section" id="qapidoc-2457"> <h4>Members<a class="headerlink" href="#qapidoc-2457" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device’s ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">memaddr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>physical address in memory, where device is mapped</dd> <dt><code class="docutils literal notranslate"><span class="pre">requested-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the user requested size of the device</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the (current) size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">max-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the maximum size of memory that the device can provide</dd> <dt><code class="docutils literal notranslate"><span class="pre">block-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the block size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>NUMA node number where device is assigned to</dd> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>memory backend linked with the region</dd> </dl> </div> <div class="section" id="qapidoc-2458"> <h4>Since<a class="headerlink" href="#qapidoc-2458" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-2462"> <h3><a class="toc-backref" href="#id451"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2462" title="Permalink to this headline">¶</a></h3> <p>Sgx EPC state information</p> <div class="section" id="qapidoc-2460"> <h4>Members<a class="headerlink" href="#qapidoc-2460" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device’s ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">memaddr</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>physical address in memory, where device is mapped</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>memory backend linked with device</dd> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the numa node (Since: 7.0)</dd> </dl> </div> <div class="section" id="qapidoc-2461"> <h4>Since<a class="headerlink" href="#qapidoc-2461" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2465"> <h3><a class="toc-backref" href="#id452"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfoKind</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2465" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2463"> <h4>Values<a class="headerlink" href="#qapidoc-2463" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dimm</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">nvdimm</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">virtio-pmem</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">virtio-mem</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sgx-epc</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2464"> <h4>Since<a class="headerlink" href="#qapidoc-2464" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2468"> <h3><a class="toc-backref" href="#id453"><code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfoWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2468" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2466"> <h4>Members<a class="headerlink" href="#qapidoc-2466" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2467"> <h4>Since<a class="headerlink" href="#qapidoc-2467" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2471"> <h3><a class="toc-backref" href="#id454"><code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfoWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2471" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2469"> <h4>Members<a class="headerlink" href="#qapidoc-2469" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2470"> <h4>Since<a class="headerlink" href="#qapidoc-2470" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2474"> <h3><a class="toc-backref" href="#id455"><code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfoWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2474" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2472"> <h4>Members<a class="headerlink" href="#qapidoc-2472" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2473"> <h4>Since<a class="headerlink" href="#qapidoc-2473" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2477"> <h3><a class="toc-backref" href="#id456"><code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfoWrapper</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2477" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2475"> <h4>Members<a class="headerlink" href="#qapidoc-2475" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2476"> <h4>Since<a class="headerlink" href="#qapidoc-2476" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2480"> <h3><a class="toc-backref" href="#id457"><code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2480" title="Permalink to this headline">¶</a></h3> <p>Union containing information about a memory device</p> <p>nvdimm is included since 2.12. virtio-pmem is included since 4.1. virtio-mem is included since 5.1. sgx-epc is included since 6.2.</p> <div class="section" id="qapidoc-2478"> <h4>Members<a class="headerlink" href="#qapidoc-2478" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">MemoryDeviceInfoKind</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfoWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"dimm"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">PCDIMMDeviceInfoWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"nvdimm"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">VirtioPMEMDeviceInfoWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"virtio-pmem"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">VirtioMEMDeviceInfoWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"virtio-mem"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">SgxEPCDeviceInfoWrapper</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"sgx-epc"</span></code></dl> </div> <div class="section" id="qapidoc-2479"> <h4>Since<a class="headerlink" href="#qapidoc-2479" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2483"> <h3><a class="toc-backref" href="#id458"><code class="docutils literal notranslate"><span class="pre">SgxEPC</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2483" title="Permalink to this headline">¶</a></h3> <p>Sgx EPC cmdline information</p> <div class="section" id="qapidoc-2481"> <h4>Members<a class="headerlink" href="#qapidoc-2481" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">memdev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>memory backend linked with device</dd> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the numa node (Since: 7.0)</dd> </dl> </div> <div class="section" id="qapidoc-2482"> <h4>Since<a class="headerlink" href="#qapidoc-2482" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2486"> <h3><a class="toc-backref" href="#id459"><code class="docutils literal notranslate"><span class="pre">SgxEPCProperties</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2486" title="Permalink to this headline">¶</a></h3> <p>SGX properties of machine types.</p> <div class="section" id="qapidoc-2484"> <h4>Members<a class="headerlink" href="#qapidoc-2484" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sgx-epc</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SgxEPC</span></code></dt> <dd>list of ids of memory-backend-epc objects.</dd> </dl> </div> <div class="section" id="qapidoc-2485"> <h4>Since<a class="headerlink" href="#qapidoc-2485" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2489"> <h3><a class="toc-backref" href="#id460"><code class="docutils literal notranslate"><span class="pre">query-memory-devices</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2489" title="Permalink to this headline">¶</a></h3> <p>Lists available memory devices and their state</p> <div class="section" id="qapidoc-2487"> <h4>Since<a class="headerlink" href="#qapidoc-2487" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-2488"> <h4>Example<a class="headerlink" href="#qapidoc-2488" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-memory-devices"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"addr"</span><span class="p">:</span> <span class="mi">5368709120</span><span class="p">,</span> <span class="s2">"hotpluggable"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"hotplugged"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"d1"</span><span class="p">,</span> <span class="s2">"memdev"</span><span class="p">:</span> <span class="s2">"/objects/memX"</span><span class="p">,</span> <span class="s2">"node"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">1073741824</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"dimm"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2494"> <h3><a class="toc-backref" href="#id461"><code class="docutils literal notranslate"><span class="pre">MEMORY_DEVICE_SIZE_CHANGE</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2494" title="Permalink to this headline">¶</a></h3> <p>Emitted when the size of a memory device changes. Only emitted for memory devices that can actually change the size (e.g., virtio-mem due to guest action).</p> <div class="section" id="qapidoc-2490"> <h4>Arguments<a class="headerlink" href="#qapidoc-2490" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device’s ID</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the new size of memory that the device provides</dd> <dt><code class="docutils literal notranslate"><span class="pre">qom-path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>path to the device object in the QOM tree (since 6.2)</dd> </dl> </div> <div class="section" id="qapidoc-2491"> <h4>Note<a class="headerlink" href="#qapidoc-2491" title="Permalink to this headline">¶</a></h4> <p>this event is rate-limited.</p> </div> <div class="section" id="qapidoc-2492"> <h4>Since<a class="headerlink" href="#qapidoc-2492" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> <div class="section" id="qapidoc-2493"> <h4>Example<a class="headerlink" href="#qapidoc-2493" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"MEMORY_DEVICE_SIZE_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"vm0"</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">1073741824</span><span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1588168529</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">201316</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2499"> <h3><a class="toc-backref" href="#id462"><code class="docutils literal notranslate"><span class="pre">MEM_UNPLUG_ERROR</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2499" title="Permalink to this headline">¶</a></h3> <p>Emitted when memory hot unplug error occurs.</p> <div class="section" id="qapidoc-2495"> <h4>Arguments<a class="headerlink" href="#qapidoc-2495" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>device name</dd> <dt><code class="docutils literal notranslate"><span class="pre">msg</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Informative message</dd> </dl> </div> <div class="section" id="qapidoc-2496"> <h4>Features<a class="headerlink" href="#qapidoc-2496" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>This event is deprecated. Use <code class="docutils literal notranslate"><span class="pre">DEVICE_UNPLUG_GUEST_ERROR</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-2497"> <h4>Since<a class="headerlink" href="#qapidoc-2497" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> <div class="section" id="qapidoc-2498"> <h4>Example<a class="headerlink" href="#qapidoc-2498" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"MEM_UNPLUG_ERROR"</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"dimm1"</span><span class="p">,</span> <span class="s2">"msg"</span><span class="p">:</span> <span class="s2">"acpi: device unplug for unsupported device"</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1265044230</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">450486</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2502"> <h3><a class="toc-backref" href="#id463"><code class="docutils literal notranslate"><span class="pre">SMPConfiguration</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2502" title="Permalink to this headline">¶</a></h3> <p>Schema for CPU topology configuration. A missing value lets QEMU figure out a suitable value based on the ones that are provided.</p> <div class="section" id="qapidoc-2500"> <h4>Members<a class="headerlink" href="#qapidoc-2500" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">cpus</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of virtual CPUs in the virtual machine</dd> <dt><code class="docutils literal notranslate"><span class="pre">sockets</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of sockets in the CPU topology</dd> <dt><code class="docutils literal notranslate"><span class="pre">dies</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of dies per socket in the CPU topology</dd> <dt><code class="docutils literal notranslate"><span class="pre">cores</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of cores per die in the CPU topology</dd> <dt><code class="docutils literal notranslate"><span class="pre">threads</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of threads per core in the CPU topology</dd> <dt><code class="docutils literal notranslate"><span class="pre">maxcpus</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>maximum number of hotpluggable virtual CPUs in the virtual machine</dd> </dl> </div> <div class="section" id="qapidoc-2501"> <h4>Since<a class="headerlink" href="#qapidoc-2501" title="Permalink to this headline">¶</a></h4> <p>6.1</p> </div> </div> <div class="section" id="qapidoc-2506"> <h3><a class="toc-backref" href="#id464"><code class="docutils literal notranslate"><span class="pre">x-query-irq</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2506" title="Permalink to this headline">¶</a></h3> <p>Query interrupt statistics</p> <div class="section" id="qapidoc-2503"> <h4>Features<a class="headerlink" href="#qapidoc-2503" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2504"> <h4>Returns<a class="headerlink" href="#qapidoc-2504" title="Permalink to this headline">¶</a></h4> <p>interrupt statistics</p> </div> <div class="section" id="qapidoc-2505"> <h4>Since<a class="headerlink" href="#qapidoc-2505" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2511"> <h3><a class="toc-backref" href="#id465"><code class="docutils literal notranslate"><span class="pre">x-query-jit</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2511" title="Permalink to this headline">¶</a></h3> <p>Query TCG compiler statistics</p> <div class="section" id="qapidoc-2507"> <h4>Features<a class="headerlink" href="#qapidoc-2507" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2508"> <h4>Returns<a class="headerlink" href="#qapidoc-2508" title="Permalink to this headline">¶</a></h4> <p>TCG compiler statistics</p> </div> <div class="section" id="qapidoc-2509"> <h4>Since<a class="headerlink" href="#qapidoc-2509" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2510"> <h4>If<a class="headerlink" href="#qapidoc-2510" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TCG</span></code></p> </div> </div> <div class="section" id="qapidoc-2515"> <h3><a class="toc-backref" href="#id466"><code class="docutils literal notranslate"><span class="pre">x-query-numa</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2515" title="Permalink to this headline">¶</a></h3> <p>Query NUMA topology information</p> <div class="section" id="qapidoc-2512"> <h4>Features<a class="headerlink" href="#qapidoc-2512" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2513"> <h4>Returns<a class="headerlink" href="#qapidoc-2513" title="Permalink to this headline">¶</a></h4> <p>topology information</p> </div> <div class="section" id="qapidoc-2514"> <h4>Since<a class="headerlink" href="#qapidoc-2514" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2520"> <h3><a class="toc-backref" href="#id467"><code class="docutils literal notranslate"><span class="pre">x-query-opcount</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2520" title="Permalink to this headline">¶</a></h3> <p>Query TCG opcode counters</p> <div class="section" id="qapidoc-2516"> <h4>Features<a class="headerlink" href="#qapidoc-2516" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2517"> <h4>Returns<a class="headerlink" href="#qapidoc-2517" title="Permalink to this headline">¶</a></h4> <p>TCG opcode counters</p> </div> <div class="section" id="qapidoc-2518"> <h4>Since<a class="headerlink" href="#qapidoc-2518" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2519"> <h4>If<a class="headerlink" href="#qapidoc-2519" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">CONFIG_TCG</span></code></p> </div> </div> <div class="section" id="qapidoc-2524"> <h3><a class="toc-backref" href="#id468"><code class="docutils literal notranslate"><span class="pre">x-query-profile</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2524" title="Permalink to this headline">¶</a></h3> <p>Query TCG profiling information</p> <div class="section" id="qapidoc-2521"> <h4>Features<a class="headerlink" href="#qapidoc-2521" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2522"> <h4>Returns<a class="headerlink" href="#qapidoc-2522" title="Permalink to this headline">¶</a></h4> <p>profile information</p> </div> <div class="section" id="qapidoc-2523"> <h4>Since<a class="headerlink" href="#qapidoc-2523" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2528"> <h3><a class="toc-backref" href="#id469"><code class="docutils literal notranslate"><span class="pre">x-query-ramblock</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2528" title="Permalink to this headline">¶</a></h3> <p>Query system ramblock information</p> <div class="section" id="qapidoc-2525"> <h4>Features<a class="headerlink" href="#qapidoc-2525" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2526"> <h4>Returns<a class="headerlink" href="#qapidoc-2526" title="Permalink to this headline">¶</a></h4> <p>system ramblock information</p> </div> <div class="section" id="qapidoc-2527"> <h4>Since<a class="headerlink" href="#qapidoc-2527" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2532"> <h3><a class="toc-backref" href="#id470"><code class="docutils literal notranslate"><span class="pre">x-query-rdma</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2532" title="Permalink to this headline">¶</a></h3> <p>Query RDMA state</p> <div class="section" id="qapidoc-2529"> <h4>Features<a class="headerlink" href="#qapidoc-2529" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2530"> <h4>Returns<a class="headerlink" href="#qapidoc-2530" title="Permalink to this headline">¶</a></h4> <p>RDMA state</p> </div> <div class="section" id="qapidoc-2531"> <h4>Since<a class="headerlink" href="#qapidoc-2531" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2536"> <h3><a class="toc-backref" href="#id471"><code class="docutils literal notranslate"><span class="pre">x-query-roms</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2536" title="Permalink to this headline">¶</a></h3> <p>Query information on the registered ROMS</p> <div class="section" id="qapidoc-2533"> <h4>Features<a class="headerlink" href="#qapidoc-2533" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2534"> <h4>Returns<a class="headerlink" href="#qapidoc-2534" title="Permalink to this headline">¶</a></h4> <p>registered ROMs</p> </div> <div class="section" id="qapidoc-2535"> <h4>Since<a class="headerlink" href="#qapidoc-2535" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2540"> <h3><a class="toc-backref" href="#id472"><code class="docutils literal notranslate"><span class="pre">x-query-usb</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2540" title="Permalink to this headline">¶</a></h3> <p>Query information on the USB devices</p> <div class="section" id="qapidoc-2537"> <h4>Features<a class="headerlink" href="#qapidoc-2537" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is meant for debugging.</dd> </dl> </div> <div class="section" id="qapidoc-2538"> <h4>Returns<a class="headerlink" href="#qapidoc-2538" title="Permalink to this headline">¶</a></h4> <p>USB device information</p> </div> <div class="section" id="qapidoc-2539"> <h4>Since<a class="headerlink" href="#qapidoc-2539" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> </div> <div class="section" id="qapidoc-2543"> <h3><a class="toc-backref" href="#id473"><code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2543" title="Permalink to this headline">¶</a></h3> <p>Virtual CPU model.</p> <p>A CPU model consists of the name of a CPU definition, to which delta changes are applied (e.g. features added/removed). Most magic values that an architecture might require should be hidden behind the name. However, if required, architectures can expose relevant properties.</p> <div class="section" id="qapidoc-2541"> <h4>Members<a class="headerlink" href="#qapidoc-2541" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the CPU definition the model is based on</dd> <dt><code class="docutils literal notranslate"><span class="pre">props</span></code>: <code class="docutils literal notranslate"><span class="pre">value</span></code> (optional)</dt> <dd>a dictionary of QOM properties to be applied</dd> </dl> </div> <div class="section" id="qapidoc-2542"> <h4>Since<a class="headerlink" href="#qapidoc-2542" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2547"> <h3><a class="toc-backref" href="#id474"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2547" title="Permalink to this headline">¶</a></h3> <p>An enumeration of CPU model expansion types.</p> <div class="section" id="qapidoc-2544"> <h4>Values<a class="headerlink" href="#qapidoc-2544" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">static</span></code></dt> <dd>Expand to a static CPU model, a combination of a static base model name and property delta changes. As the static base model will never change, the expanded CPU model will be the same, independent of QEMU version, machine type, machine options, and accelerator options. Therefore, the resulting model can be used by tooling without having to specify a compatibility machine - e.g. when displaying the “host” model. The <code class="docutils literal notranslate"><span class="pre">static</span></code> CPU models are migration-safe.</dd> <dt><code class="docutils literal notranslate"><span class="pre">full</span></code></dt> <dd>Expand all properties. The produced model is not guaranteed to be migration-safe, but allows tooling to get an insight and work with model details.</dd> </dl> </div> <div class="section" id="qapidoc-2545"> <h4>Note<a class="headerlink" href="#qapidoc-2545" title="Permalink to this headline">¶</a></h4> <p>When a non-migration-safe CPU model is expanded in static mode, some features enabled by the CPU model may be omitted, because they can’t be implemented by a static CPU model definition (e.g. cache info passthrough and PMU passthrough in x86). If you need an accurate representation of the features enabled by a non-migration-safe CPU model, use <code class="docutils literal notranslate"><span class="pre">full</span></code>. If you need a static representation that will keep ABI compatibility even when changing QEMU version or machine-type, use <code class="docutils literal notranslate"><span class="pre">static</span></code> (but keep in mind that some features may be omitted).</p> </div> <div class="section" id="qapidoc-2546"> <h4>Since<a class="headerlink" href="#qapidoc-2546" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2550"> <h3><a class="toc-backref" href="#id475"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareResult</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2550" title="Permalink to this headline">¶</a></h3> <p>An enumeration of CPU model comparison results. The result is usually calculated using e.g. CPU features or CPU generations.</p> <div class="section" id="qapidoc-2548"> <h4>Values<a class="headerlink" href="#qapidoc-2548" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">incompatible</span></code></dt> <dd>If model A is incompatible to model B, model A is not guaranteed to run where model B runs and the other way around.</dd> <dt><code class="docutils literal notranslate"><span class="pre">identical</span></code></dt> <dd>If model A is identical to model B, model A is guaranteed to run where model B runs and the other way around.</dd> <dt><code class="docutils literal notranslate"><span class="pre">superset</span></code></dt> <dd>If model A is a superset of model B, model B is guaranteed to run where model A runs. There are no guarantees about the other way.</dd> <dt><code class="docutils literal notranslate"><span class="pre">subset</span></code></dt> <dd>If model A is a subset of model B, model A is guaranteed to run where model B runs. There are no guarantees about the other way.</dd> </dl> </div> <div class="section" id="qapidoc-2549"> <h4>Since<a class="headerlink" href="#qapidoc-2549" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> </div> <div class="section" id="qapidoc-2554"> <h3><a class="toc-backref" href="#id476"><code class="docutils literal notranslate"><span class="pre">CpuModelBaselineInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2554" title="Permalink to this headline">¶</a></h3> <p>The result of a CPU model baseline.</p> <div class="section" id="qapidoc-2551"> <h4>Members<a class="headerlink" href="#qapidoc-2551" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">model</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>the baselined CpuModelInfo.</dd> </dl> </div> <div class="section" id="qapidoc-2552"> <h4>Since<a class="headerlink" href="#qapidoc-2552" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2553"> <h4>If<a class="headerlink" href="#qapidoc-2553" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code></p> </div> </div> <div class="section" id="qapidoc-2559"> <h3><a class="toc-backref" href="#id477"><code class="docutils literal notranslate"><span class="pre">CpuModelCompareInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2559" title="Permalink to this headline">¶</a></h3> <p>The result of a CPU model comparison.</p> <div class="section" id="qapidoc-2555"> <h4>Members<a class="headerlink" href="#qapidoc-2555" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">result</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelCompareResult</span></code></dt> <dd>The result of the compare operation.</dd> <dt><code class="docutils literal notranslate"><span class="pre">responsible-properties</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code></dt> <dd>List of properties that led to the comparison result not being identical.</dd> </dl> </div> <div class="section" id="qapidoc-2556"> <code class="docutils literal notranslate"><span class="pre">responsible-properties</span></code> is a list of QOM property names that led to both CPUs not being detected as identical. For identical models, this list is empty. If a QOM property is read-only, that means there’s no known way to make the CPU models identical. If the special property name “type” is included, the models are by definition not identical and cannot be made identical.</div> <div class="section" id="qapidoc-2557"> <h4>Since<a class="headerlink" href="#qapidoc-2557" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2558"> <h4>If<a class="headerlink" href="#qapidoc-2558" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code></p> </div> </div> <div class="section" id="qapidoc-2565"> <h3><a class="toc-backref" href="#id478"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-comparison</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2565" title="Permalink to this headline">¶</a></h3> <p>Compares two CPU models, returning how they compare in a specific configuration. The results indicates how both models compare regarding runnability. This result can be used by tooling to make decisions if a certain CPU model will run in a certain configuration or if a compatible CPU model has to be created by baselining.</p> <p>Usually, a CPU model is compared against the maximum possible CPU model of a certain configuration (e.g. the “host” model for KVM). If that CPU model is identical or a subset, it will run in that configuration.</p> <p>The result returned by this command may be affected by:</p> <ul class="simple"> <li>QEMU version: CPU models may look different depending on the QEMU version. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine-type: CPU model may look different depending on the machine-type. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine options (including accelerator): in some architectures, CPU models may look different depending on machine and accelerator options. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>“-cpu” arguments and global properties: arguments to the -cpu option and global properties may affect expansion of CPU models. Using query-cpu-model-expansion while using these is not advised.</li> </ul> <p>Some architectures may not support comparing CPU models. s390x supports comparing CPU models.</p> <div class="section" id="qapidoc-2560"> <h4>Arguments<a class="headerlink" href="#qapidoc-2560" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">modela</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">modelb</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2561"> <h4>Returns<a class="headerlink" href="#qapidoc-2561" title="Permalink to this headline">¶</a></h4> <p>a CpuModelBaselineInfo. Returns an error if comparing CPU models is not supported, if a model cannot be used, if a model contains an unknown cpu definition name, unknown properties or properties with wrong types.</p> </div> <div class="section" id="qapidoc-2562"> <h4>Note<a class="headerlink" href="#qapidoc-2562" title="Permalink to this headline">¶</a></h4> <p>this command isn’t specific to s390x, but is only implemented on this architecture currently.</p> </div> <div class="section" id="qapidoc-2563"> <h4>Since<a class="headerlink" href="#qapidoc-2563" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2564"> <h4>If<a class="headerlink" href="#qapidoc-2564" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code></p> </div> </div> <div class="section" id="qapidoc-2571"> <h3><a class="toc-backref" href="#id479"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-baseline</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2571" title="Permalink to this headline">¶</a></h3> <p>Baseline two CPU models, creating a compatible third model. The created model will always be a static, migration-safe CPU model (see “static” CPU model expansion for details).</p> <p>This interface can be used by tooling to create a compatible CPU model out two CPU models. The created CPU model will be identical to or a subset of both CPU models when comparing them. Therefore, the created CPU model is guaranteed to run where the given CPU models run.</p> <p>The result returned by this command may be affected by:</p> <ul class="simple"> <li>QEMU version: CPU models may look different depending on the QEMU version. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine-type: CPU model may look different depending on the machine-type. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine options (including accelerator): in some architectures, CPU models may look different depending on machine and accelerator options. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>“-cpu” arguments and global properties: arguments to the -cpu option and global properties may affect expansion of CPU models. Using query-cpu-model-expansion while using these is not advised.</li> </ul> <p>Some architectures may not support baselining CPU models. s390x supports baselining CPU models.</p> <div class="section" id="qapidoc-2566"> <h4>Arguments<a class="headerlink" href="#qapidoc-2566" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">modela</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">modelb</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2567"> <h4>Returns<a class="headerlink" href="#qapidoc-2567" title="Permalink to this headline">¶</a></h4> <p>a CpuModelBaselineInfo. Returns an error if baselining CPU models is not supported, if a model cannot be used, if a model contains an unknown cpu definition name, unknown properties or properties with wrong types.</p> </div> <div class="section" id="qapidoc-2568"> <h4>Note<a class="headerlink" href="#qapidoc-2568" title="Permalink to this headline">¶</a></h4> <p>this command isn’t specific to s390x, but is only implemented on this architecture currently.</p> </div> <div class="section" id="qapidoc-2569"> <h4>Since<a class="headerlink" href="#qapidoc-2569" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2570"> <h4>If<a class="headerlink" href="#qapidoc-2570" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code></p> </div> </div> <div class="section" id="qapidoc-2575"> <h3><a class="toc-backref" href="#id480"><code class="docutils literal notranslate"><span class="pre">CpuModelExpansionInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2575" title="Permalink to this headline">¶</a></h3> <p>The result of a cpu model expansion.</p> <div class="section" id="qapidoc-2572"> <h4>Members<a class="headerlink" href="#qapidoc-2572" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">model</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>the expanded CpuModelInfo.</dd> <dt><code class="docutils literal notranslate"><span class="pre">deprecated-props</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (<strong>If: </strong><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code>)</dt> <dd>a list of properties that are flagged as deprecated by the CPU vendor. The list depends on the CpuModelExpansionType: “static” properties are a subset of the enabled-properties for the expanded model; “full” properties are a set of properties that are deprecated across all models for the architecture. (since: 9.1).</dd> </dl> </div> <div class="section" id="qapidoc-2573"> <h4>Since<a class="headerlink" href="#qapidoc-2573" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2574"> <h4>If<a class="headerlink" href="#qapidoc-2574" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span> <span class="pre">or</span> <span class="pre">TARGET_I386</span> <span class="pre">or</span> <span class="pre">TARGET_ARM</span></code></p> </div> </div> <div class="section" id="qapidoc-2580"> <h3><a class="toc-backref" href="#id481"><code class="docutils literal notranslate"><span class="pre">query-cpu-model-expansion</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2580" title="Permalink to this headline">¶</a></h3> <p>Expands a given CPU model (or a combination of CPU model + additional options) to different granularities, allowing tooling to get an understanding what a specific CPU model looks like in QEMU under a certain configuration.</p> <p>This interface can be used to query the “host” CPU model.</p> <p>The data returned by this command may be affected by:</p> <ul class="simple"> <li>QEMU version: CPU models may look different depending on the QEMU version. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine-type: CPU model may look different depending on the machine-type. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>machine options (including accelerator): in some architectures, CPU models may look different depending on machine and accelerator options. (Except for CPU models reported as “static” in query-cpu-definitions.)</li> <li>“-cpu” arguments and global properties: arguments to the -cpu option and global properties may affect expansion of CPU models. Using query-cpu-model-expansion while using these is not advised.</li> </ul> <p>Some architectures may not support all expansion types. s390x supports “full” and “static”. Arm only supports “full”.</p> <div class="section" id="qapidoc-2576"> <h4>Arguments<a class="headerlink" href="#qapidoc-2576" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelExpansionType</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">model</span></code>: <code class="docutils literal notranslate"><span class="pre">CpuModelInfo</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2577"> <h4>Returns<a class="headerlink" href="#qapidoc-2577" title="Permalink to this headline">¶</a></h4> <p>a CpuModelExpansionInfo. Returns an error if expanding CPU models is not supported, if the model cannot be expanded, if the model contains an unknown CPU definition name, unknown properties or properties with a wrong type. Also returns an error if an expansion type is not supported.</p> </div> <div class="section" id="qapidoc-2578"> <h4>Since<a class="headerlink" href="#qapidoc-2578" title="Permalink to this headline">¶</a></h4> <p>2.8</p> </div> <div class="section" id="qapidoc-2579"> <h4>If<a class="headerlink" href="#qapidoc-2579" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span> <span class="pre">or</span> <span class="pre">TARGET_I386</span> <span class="pre">or</span> <span class="pre">TARGET_ARM</span></code></p> </div> </div> <div class="section" id="qapidoc-2585"> <h3><a class="toc-backref" href="#id482"><code class="docutils literal notranslate"><span class="pre">CpuDefinitionInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2585" title="Permalink to this headline">¶</a></h3> <p>Virtual CPU definition.</p> <div class="section" id="qapidoc-2581"> <h4>Members<a class="headerlink" href="#qapidoc-2581" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the CPU definition</dd> <dt><code class="docutils literal notranslate"><span class="pre">migration-safe</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether a CPU definition can be safely used for migration in combination with a QEMU compatibility machine when migrating between different QEMU versions and between hosts with different sets of (hardware or software) capabilities. If not provided, information is not available and callers should not assume the CPU definition to be migration-safe. (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">static</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether a CPU definition is static and will not change depending on QEMU version, machine type, machine options and accelerator options. A static model is always migration-safe. (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">unavailable-features</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">string</span></code> (optional)</dt> <dd>List of properties that prevent the CPU model from running in the current host. (since 2.8)</dd> <dt><code class="docutils literal notranslate"><span class="pre">typename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Type name that can be used as argument to <code class="docutils literal notranslate"><span class="pre">device-list-properties</span></code>, to introspect properties configurable using -cpu or -global. (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">alias-of</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>Name of CPU model this model is an alias for. The target of the CPU model alias may change depending on the machine type. Management software is supposed to translate CPU model aliases in the VM configuration, because aliases may stop being migration-safe in the future (since 4.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>If true, this CPU model is deprecated and may be removed in in some future version of QEMU according to the QEMU deprecation policy. (since 5.2)</dd> </dl> </div> <div class="section" id="qapidoc-2582"> <code class="docutils literal notranslate"><span class="pre">unavailable-features</span></code> is a list of QOM property names that represent CPU model attributes that prevent the CPU from running. If the QOM property is read-only, that means there’s no known way to make the CPU model run in the current host. Implementations that choose not to provide specific information return the property name “type”. If the property is read-write, it means that it MAY be possible to run the CPU model in the current host if that property is changed. Management software can use it as hints to suggest or choose an alternative for the user, or just to generate meaningful error messages explaining why the CPU model can’t be used. If <code class="docutils literal notranslate"><span class="pre">unavailable-features</span></code> is an empty list, the CPU model is runnable using the current host and machine-type. If <code class="docutils literal notranslate"><span class="pre">unavailable-features</span></code> is not present, runnability information for the CPU is not available.</div> <div class="section" id="qapidoc-2583"> <h4>Since<a class="headerlink" href="#qapidoc-2583" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2584"> <h4>If<a class="headerlink" href="#qapidoc-2584" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_PPC</span> <span class="pre">or</span> <span class="pre">TARGET_ARM</span> <span class="pre">or</span> <span class="pre">TARGET_I386</span> <span class="pre">or</span> <span class="pre">TARGET_S390X</span> <span class="pre">or</span> <span class="pre">TARGET_MIPS</span></code></p> </div> </div> <div class="section" id="qapidoc-2589"> <h3><a class="toc-backref" href="#id483"><code class="docutils literal notranslate"><span class="pre">query-cpu-definitions</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2589" title="Permalink to this headline">¶</a></h3> <p>Return a list of supported virtual CPU definitions</p> <div class="section" id="qapidoc-2586"> <h4>Returns<a class="headerlink" href="#qapidoc-2586" title="Permalink to this headline">¶</a></h4> <p>a list of CpuDefInfo</p> </div> <div class="section" id="qapidoc-2587"> <h4>Since<a class="headerlink" href="#qapidoc-2587" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2588"> <h4>If<a class="headerlink" href="#qapidoc-2588" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_PPC</span> <span class="pre">or</span> <span class="pre">TARGET_ARM</span> <span class="pre">or</span> <span class="pre">TARGET_I386</span> <span class="pre">or</span> <span class="pre">TARGET_S390X</span> <span class="pre">or</span> <span class="pre">TARGET_MIPS</span></code></p> </div> </div> </div> <div class="section" id="qapidoc-2590"> <h2><a class="toc-backref" href="#id484">Record/replay</a><a class="headerlink" href="#qapidoc-2590" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2593"> <h3><a class="toc-backref" href="#id485"><code class="docutils literal notranslate"><span class="pre">ReplayMode</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2593" title="Permalink to this headline">¶</a></h3> <p>Mode of the replay subsystem.</p> <div class="section" id="qapidoc-2591"> <h4>Values<a class="headerlink" href="#qapidoc-2591" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>normal execution mode. Replay or record are not enabled.</dd> <dt><code class="docutils literal notranslate"><span class="pre">record</span></code></dt> <dd>record mode. All non-deterministic data is written into the replay log.</dd> <dt><code class="docutils literal notranslate"><span class="pre">play</span></code></dt> <dd>replay mode. Non-deterministic data required for system execution is read from the log.</dd> </dl> </div> <div class="section" id="qapidoc-2592"> <h4>Since<a class="headerlink" href="#qapidoc-2592" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> </div> <div class="section" id="qapidoc-2596"> <h3><a class="toc-backref" href="#id486"><code class="docutils literal notranslate"><span class="pre">ReplayInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2596" title="Permalink to this headline">¶</a></h3> <p>Record/replay information.</p> <div class="section" id="qapidoc-2594"> <h4>Members<a class="headerlink" href="#qapidoc-2594" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mode</span></code>: <code class="docutils literal notranslate"><span class="pre">ReplayMode</span></code></dt> <dd>current mode.</dd> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the record/replay log file. It is present only in record or replay modes, when the log is recorded or replayed.</dd> <dt><code class="docutils literal notranslate"><span class="pre">icount</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>current number of executed instructions.</dd> </dl> </div> <div class="section" id="qapidoc-2595"> <h4>Since<a class="headerlink" href="#qapidoc-2595" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> </div> <div class="section" id="qapidoc-2600"> <h3><a class="toc-backref" href="#id487"><code class="docutils literal notranslate"><span class="pre">query-replay</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2600" title="Permalink to this headline">¶</a></h3> <p>Retrieve the record/replay information. It includes current instruction count which may be used for <code class="docutils literal notranslate"><span class="pre">replay-break</span></code> and <code class="docutils literal notranslate"><span class="pre">replay-seek</span></code> commands.</p> <div class="section" id="qapidoc-2597"> <h4>Returns<a class="headerlink" href="#qapidoc-2597" title="Permalink to this headline">¶</a></h4> <p>record/replay information.</p> </div> <div class="section" id="qapidoc-2598"> <h4>Since<a class="headerlink" href="#qapidoc-2598" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-2599"> <h4>Example<a class="headerlink" href="#qapidoc-2599" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-replay"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"mode"</span><span class="p">:</span> <span class="s2">"play"</span><span class="p">,</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"log.rr"</span><span class="p">,</span> <span class="s2">"icount"</span><span class="p">:</span> <span class="mi">220414</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2604"> <h3><a class="toc-backref" href="#id488"><code class="docutils literal notranslate"><span class="pre">replay-break</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2604" title="Permalink to this headline">¶</a></h3> <p>Set replay breakpoint at instruction count <code class="docutils literal notranslate"><span class="pre">icount</span></code>. Execution stops when the specified instruction is reached. There can be at most one breakpoint. When breakpoint is set, any prior one is removed. The breakpoint may be set only in replay mode and only “in the future”, i.e. at instruction counts greater than the current one. The current instruction count can be observed with <code class="docutils literal notranslate"><span class="pre">query-replay</span></code>.</p> <div class="section" id="qapidoc-2601"> <h4>Arguments<a class="headerlink" href="#qapidoc-2601" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">icount</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>instruction count to stop at</dd> </dl> </div> <div class="section" id="qapidoc-2602"> <h4>Since<a class="headerlink" href="#qapidoc-2602" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-2603"> <h4>Example<a class="headerlink" href="#qapidoc-2603" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"replay-break"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"icount"</span><span class="p">:</span> <span class="mi">220414</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2607"> <h3><a class="toc-backref" href="#id489"><code class="docutils literal notranslate"><span class="pre">replay-delete-break</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2607" title="Permalink to this headline">¶</a></h3> <p>Remove replay breakpoint which was set with <code class="docutils literal notranslate"><span class="pre">replay-break</span></code>. The command is ignored when there are no replay breakpoints.</p> <div class="section" id="qapidoc-2605"> <h4>Since<a class="headerlink" href="#qapidoc-2605" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-2606"> <h4>Example<a class="headerlink" href="#qapidoc-2606" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"replay-delete-break"</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2611"> <h3><a class="toc-backref" href="#id490"><code class="docutils literal notranslate"><span class="pre">replay-seek</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2611" title="Permalink to this headline">¶</a></h3> <p>Automatically proceed to the instruction count <code class="docutils literal notranslate"><span class="pre">icount</span></code>, when replaying the execution. The command automatically loads nearest snapshot and replays the execution to find the desired instruction. When there is no preceding snapshot or the execution is not replayed, then the command fails. icount for the reference may be obtained with <code class="docutils literal notranslate"><span class="pre">query-replay</span></code> command.</p> <div class="section" id="qapidoc-2608"> <h4>Arguments<a class="headerlink" href="#qapidoc-2608" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">icount</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>target instruction count</dd> </dl> </div> <div class="section" id="qapidoc-2609"> <h4>Since<a class="headerlink" href="#qapidoc-2609" title="Permalink to this headline">¶</a></h4> <p>5.2</p> </div> <div class="section" id="qapidoc-2610"> <h4>Example<a class="headerlink" href="#qapidoc-2610" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"replay-seek"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"icount"</span><span class="p">:</span> <span class="mi">220414</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2612"> <h2><a class="toc-backref" href="#id491">Yank feature</a><a class="headerlink" href="#qapidoc-2612" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2615"> <h3><a class="toc-backref" href="#id492"><code class="docutils literal notranslate"><span class="pre">YankInstanceType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2615" title="Permalink to this headline">¶</a></h3> <p>An enumeration of yank instance types. See <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> for more information.</p> <div class="section" id="qapidoc-2613"> <h4>Values<a class="headerlink" href="#qapidoc-2613" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">block-node</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">chardev</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">migration</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2614"> <h4>Since<a class="headerlink" href="#qapidoc-2614" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2618"> <h3><a class="toc-backref" href="#id493"><code class="docutils literal notranslate"><span class="pre">YankInstanceBlockNode</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2618" title="Permalink to this headline">¶</a></h3> <p>Specifies which block graph node to yank. See <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> for more information.</p> <div class="section" id="qapidoc-2616"> <h4>Members<a class="headerlink" href="#qapidoc-2616" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the name of the block graph node</dd> </dl> </div> <div class="section" id="qapidoc-2617"> <h4>Since<a class="headerlink" href="#qapidoc-2617" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2621"> <h3><a class="toc-backref" href="#id494"><code class="docutils literal notranslate"><span class="pre">YankInstanceChardev</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2621" title="Permalink to this headline">¶</a></h3> <p>Specifies which character device to yank. See <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> for more information.</p> <div class="section" id="qapidoc-2619"> <h4>Members<a class="headerlink" href="#qapidoc-2619" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the chardev’s ID</dd> </dl> </div> <div class="section" id="qapidoc-2620"> <h4>Since<a class="headerlink" href="#qapidoc-2620" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2624"> <h3><a class="toc-backref" href="#id495"><code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2624" title="Permalink to this headline">¶</a></h3> <p>A yank instance can be yanked with the <code class="docutils literal notranslate"><span class="pre">yank</span></code> qmp command to recover from a hanging QEMU.</p> <dl class="docutils"> <dt>Currently implemented yank instances:</dt> <dd><ul class="first last simple"> <li>nbd block device: Yanking it will shut down the connection to the nbd server without attempting to reconnect.</li> <li>socket chardev: Yanking it will shut down the connected socket.</li> <li>migration: Yanking it will shut down all migration connections. Unlike <code class="docutils literal notranslate"><span class="pre">migrate_cancel</span></code>, it will not notify the migration process, so migration will go into <code class="docutils literal notranslate"><span class="pre">failed</span></code> state, instead of <code class="docutils literal notranslate"><span class="pre">cancelled</span></code> state. <code class="docutils literal notranslate"><span class="pre">yank</span></code> should be used to recover from hangs.</li> </ul> </dd> </dl> <div class="section" id="qapidoc-2622"> <h4>Members<a class="headerlink" href="#qapidoc-2622" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">YankInstanceType</span></code></dt> <dd>Not documented</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">YankInstanceBlockNode</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"block-node"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">YankInstanceChardev</span></code> when <code class="docutils literal notranslate"><span class="pre">type</span></code> is <code class="docutils literal notranslate"><span class="pre">"chardev"</span></code></dl> </div> <div class="section" id="qapidoc-2623"> <h4>Since<a class="headerlink" href="#qapidoc-2623" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2629"> <h3><a class="toc-backref" href="#id496"><code class="docutils literal notranslate"><span class="pre">yank</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2629" title="Permalink to this headline">¶</a></h3> <p>Try to recover from hanging QEMU by yanking the specified instances. See <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> for more information.</p> <p>Takes a list of <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> as argument.</p> <div class="section" id="qapidoc-2625"> <h4>Arguments<a class="headerlink" href="#qapidoc-2625" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">instances</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">YankInstance</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2626"> <h4>Returns<a class="headerlink" href="#qapidoc-2626" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li><code class="docutils literal notranslate"><span class="pre">DeviceNotFound</span></code> error, if any of the YankInstances doesn’t exist</li> </ul> </div> <div class="section" id="qapidoc-2627"> <h4>Example<a class="headerlink" href="#qapidoc-2627" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"yank"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"instances"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"block-node"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"nbd0"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2628"> <h4>Since<a class="headerlink" href="#qapidoc-2628" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2633"> <h3><a class="toc-backref" href="#id497"><code class="docutils literal notranslate"><span class="pre">query-yank</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2633" title="Permalink to this headline">¶</a></h3> <p>Query yank instances. See <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code> for more information.</p> <div class="section" id="qapidoc-2630"> <h4>Returns<a class="headerlink" href="#qapidoc-2630" title="Permalink to this headline">¶</a></h4> <p>list of <code class="docutils literal notranslate"><span class="pre">YankInstance</span></code></p> </div> <div class="section" id="qapidoc-2631"> <h4>Example<a class="headerlink" href="#qapidoc-2631" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-yank"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"block-node"</span><span class="p">,</span> <span class="s2">"node-name"</span><span class="p">:</span> <span class="s2">"nbd0"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2632"> <h4>Since<a class="headerlink" href="#qapidoc-2632" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> </div> <div class="section" id="qapidoc-2634"> <h2><a class="toc-backref" href="#id498">Miscellanea</a><a class="headerlink" href="#qapidoc-2634" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2639"> <h3><a class="toc-backref" href="#id499"><code class="docutils literal notranslate"><span class="pre">add_client</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2639" title="Permalink to this headline">¶</a></h3> <p>Allow client connections for VNC, Spice and socket based character devices to be passed in to QEMU via SCM_RIGHTS.</p> <div class="section" id="qapidoc-2635"> <h4>Arguments<a class="headerlink" href="#qapidoc-2635" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">protocol</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>protocol name. Valid names are “vnc”, “spice” or the name of a character device (eg. from -chardev id=XXXX)</dd> <dt><code class="docutils literal notranslate"><span class="pre">fdname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>file descriptor name previously passed via ‘getfd’ command</dd> <dt><code class="docutils literal notranslate"><span class="pre">skipauth</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to skip authentication. Only applies to “vnc” and “spice” protocols</dd> <dt><code class="docutils literal notranslate"><span class="pre">tls</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>whether to perform TLS. Only applies to the “spice” protocol</dd> </dl> </div> <div class="section" id="qapidoc-2636"> <h4>Returns<a class="headerlink" href="#qapidoc-2636" title="Permalink to this headline">¶</a></h4> <p>nothing on success.</p> </div> <div class="section" id="qapidoc-2637"> <h4>Since<a class="headerlink" href="#qapidoc-2637" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2638"> <h4>Example<a class="headerlink" href="#qapidoc-2638" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"add_client"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"vnc"</span><span class="p">,</span> <span class="s2">"fdname"</span><span class="p">:</span> <span class="s2">"myclient"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2642"> <h3><a class="toc-backref" href="#id500"><code class="docutils literal notranslate"><span class="pre">NameInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2642" title="Permalink to this headline">¶</a></h3> <p>Guest name information.</p> <div class="section" id="qapidoc-2640"> <h4>Members<a class="headerlink" href="#qapidoc-2640" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>The name of the guest</dd> </dl> </div> <div class="section" id="qapidoc-2641"> <h4>Since<a class="headerlink" href="#qapidoc-2641" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2646"> <h3><a class="toc-backref" href="#id501"><code class="docutils literal notranslate"><span class="pre">query-name</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2646" title="Permalink to this headline">¶</a></h3> <p>Return the name information of a guest.</p> <div class="section" id="qapidoc-2643"> <h4>Returns<a class="headerlink" href="#qapidoc-2643" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">NameInfo</span></code> of the guest</p> </div> <div class="section" id="qapidoc-2644"> <h4>Since<a class="headerlink" href="#qapidoc-2644" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2645"> <h4>Example<a class="headerlink" href="#qapidoc-2645" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-name"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"qemu-name"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2649"> <h3><a class="toc-backref" href="#id502"><code class="docutils literal notranslate"><span class="pre">IOThreadInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2649" title="Permalink to this headline">¶</a></h3> <p>Information about an iothread</p> <div class="section" id="qapidoc-2647"> <h4>Members<a class="headerlink" href="#qapidoc-2647" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the identifier of the iothread</dd> <dt><code class="docutils literal notranslate"><span class="pre">thread-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>ID of the underlying host thread</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-max-ns</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum polling time in ns, 0 means polling is disabled (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-grow</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>how many ns will be added to polling time, 0 means that it’s not configured (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">poll-shrink</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>how many ns will be removed from polling time, 0 means that it’s not configured (since 2.9)</dd> <dt><code class="docutils literal notranslate"><span class="pre">aio-max-batch</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>maximum number of requests in a batch for the AIO engine, 0 means that the engine will use its default (since 6.1)</dd> </dl> </div> <div class="section" id="qapidoc-2648"> <h4>Since<a class="headerlink" href="#qapidoc-2648" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> </div> <div class="section" id="qapidoc-2654"> <h3><a class="toc-backref" href="#id503"><code class="docutils literal notranslate"><span class="pre">query-iothreads</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2654" title="Permalink to this headline">¶</a></h3> <p>Returns a list of information about each iothread.</p> <div class="section" id="qapidoc-2650"> <h4>Note<a class="headerlink" href="#qapidoc-2650" title="Permalink to this headline">¶</a></h4> <p>this list excludes the QEMU main loop thread, which is not declared using the -object iothread command-line option. It is always the main thread of the process.</p> </div> <div class="section" id="qapidoc-2651"> <h4>Returns<a class="headerlink" href="#qapidoc-2651" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">IOThreadInfo</span></code> for each iothread</p> </div> <div class="section" id="qapidoc-2652"> <h4>Since<a class="headerlink" href="#qapidoc-2652" title="Permalink to this headline">¶</a></h4> <p>2.0</p> </div> <div class="section" id="qapidoc-2653"> <h4>Example<a class="headerlink" href="#qapidoc-2653" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-iothreads"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"iothread0"</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span><span class="mi">3134</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"id"</span><span class="p">:</span><span class="s2">"iothread1"</span><span class="p">,</span> <span class="s2">"thread-id"</span><span class="p">:</span><span class="mi">3135</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2658"> <h3><a class="toc-backref" href="#id504"><code class="docutils literal notranslate"><span class="pre">stop</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2658" title="Permalink to this headline">¶</a></h3> <p>Stop all guest VCPU execution.</p> <div class="section" id="qapidoc-2655"> <h4>Since<a class="headerlink" href="#qapidoc-2655" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2656"> <h4>Notes<a class="headerlink" href="#qapidoc-2656" title="Permalink to this headline">¶</a></h4> <p>This function will succeed even if the guest is already in the stopped state. In “inmigrate” state, it will ensure that the guest remains paused once migration finishes, as if the -S option was passed on the command line.</p> </div> <div class="section" id="qapidoc-2657"> <h4>Example<a class="headerlink" href="#qapidoc-2657" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"stop"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2663"> <h3><a class="toc-backref" href="#id505"><code class="docutils literal notranslate"><span class="pre">cont</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2663" title="Permalink to this headline">¶</a></h3> <p>Resume guest VCPU execution.</p> <div class="section" id="qapidoc-2659"> <h4>Since<a class="headerlink" href="#qapidoc-2659" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2660"> <h4>Returns<a class="headerlink" href="#qapidoc-2660" title="Permalink to this headline">¶</a></h4> <p>If successful, nothing</p> </div> <div class="section" id="qapidoc-2661"> <h4>Notes<a class="headerlink" href="#qapidoc-2661" title="Permalink to this headline">¶</a></h4> <p>This command will succeed if the guest is currently running. It will also succeed if the guest is in the “inmigrate” state; in this case, the effect of the command is to make sure the guest starts once migration finishes, removing the effect of the -S command line option if it was passed.</p> </div> <div class="section" id="qapidoc-2662"> <h4>Example<a class="headerlink" href="#qapidoc-2662" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"cont"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2668"> <h3><a class="toc-backref" href="#id506"><code class="docutils literal notranslate"><span class="pre">x-exit-preconfig</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2668" title="Permalink to this headline">¶</a></h3> <p>Exit from “preconfig” state</p> <p>This command makes QEMU exit the preconfig state and proceed with VM initialization using configuration data provided on the command line and via the QMP monitor during the preconfig state. The command is only available during the preconfig state (i.e. when the –preconfig command line option was in use).</p> <div class="section" id="qapidoc-2664"> <h4>Features<a class="headerlink" href="#qapidoc-2664" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">unstable</span></code></dt> <dd>This command is experimental.</dd> </dl> </div> <div class="section" id="qapidoc-2665"> Since 3.0</div> <div class="section" id="qapidoc-2666"> <h4>Returns<a class="headerlink" href="#qapidoc-2666" title="Permalink to this headline">¶</a></h4> <p>nothing</p> </div> <div class="section" id="qapidoc-2667"> <h4>Example<a class="headerlink" href="#qapidoc-2667" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"x-exit-preconfig"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2675"> <h3><a class="toc-backref" href="#id507"><code class="docutils literal notranslate"><span class="pre">human-monitor-command</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2675" title="Permalink to this headline">¶</a></h3> <p>Execute a command on the human monitor and return the output.</p> <div class="section" id="qapidoc-2669"> <h4>Arguments<a class="headerlink" href="#qapidoc-2669" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">command-line</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the command to execute in the human monitor</dd> <dt><code class="docutils literal notranslate"><span class="pre">cpu-index</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The CPU to use for commands that require an implicit CPU</dd> </dl> </div> <div class="section" id="qapidoc-2670"> <h4>Features<a class="headerlink" href="#qapidoc-2670" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">savevm-monitor-nodes</span></code></dt> <dd>If present, HMP command savevm only snapshots monitor-owned nodes if they have no parents. This allows the use of ‘savevm’ with -blockdev. (since 4.2)</dd> </dl> </div> <div class="section" id="qapidoc-2671"> <h4>Returns<a class="headerlink" href="#qapidoc-2671" title="Permalink to this headline">¶</a></h4> <p>the output of the command as a string</p> </div> <div class="section" id="qapidoc-2672"> <h4>Since<a class="headerlink" href="#qapidoc-2672" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2673"> <h4>Notes<a class="headerlink" href="#qapidoc-2673" title="Permalink to this headline">¶</a></h4> <p>This command only exists as a stop-gap. Its use is highly discouraged. The semantics of this command are not guaranteed: this means that command names, arguments and responses can change or be removed at ANY time. Applications that rely on long term stability guarantees should NOT use this command.</p> <p>Known limitations:</p> <ul class="simple"> <li>This command is stateless, this means that commands that depend on state information (such as getfd) might not work</li> <li>Commands that prompt the user for data don’t currently work</li> </ul> </div> <div class="section" id="qapidoc-2674"> <h4>Example<a class="headerlink" href="#qapidoc-2674" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"human-monitor-command"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"command-line"</span><span class="p">:</span> <span class="s2">"info kvm"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="s2">"kvm support: enabled</span><span class="se">\r\n</span><span class="s2">"</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2681"> <h3><a class="toc-backref" href="#id508"><code class="docutils literal notranslate"><span class="pre">getfd</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2681" title="Permalink to this headline">¶</a></h3> <p>Receive a file descriptor via SCM rights and assign it a name</p> <div class="section" id="qapidoc-2676"> <h4>Arguments<a class="headerlink" href="#qapidoc-2676" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>file descriptor name</dd> </dl> </div> <div class="section" id="qapidoc-2677"> <h4>Returns<a class="headerlink" href="#qapidoc-2677" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-2678"> <h4>Since<a class="headerlink" href="#qapidoc-2678" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2679"> <h4>Notes<a class="headerlink" href="#qapidoc-2679" title="Permalink to this headline">¶</a></h4> <p>If <code class="docutils literal notranslate"><span class="pre">fdname</span></code> already exists, the file descriptor assigned to it will be closed and replaced by the received file descriptor.</p> <p>The ‘closefd’ command can be used to explicitly close the file descriptor when it is no longer needed.</p> </div> <div class="section" id="qapidoc-2680"> <h4>Example<a class="headerlink" href="#qapidoc-2680" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"getfd"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"fdname"</span><span class="p">:</span> <span class="s2">"fd1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2686"> <h3><a class="toc-backref" href="#id509"><code class="docutils literal notranslate"><span class="pre">closefd</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2686" title="Permalink to this headline">¶</a></h3> <p>Close a file descriptor previously passed via SCM rights</p> <div class="section" id="qapidoc-2682"> <h4>Arguments<a class="headerlink" href="#qapidoc-2682" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdname</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>file descriptor name</dd> </dl> </div> <div class="section" id="qapidoc-2683"> <h4>Returns<a class="headerlink" href="#qapidoc-2683" title="Permalink to this headline">¶</a></h4> <p>Nothing on success</p> </div> <div class="section" id="qapidoc-2684"> <h4>Since<a class="headerlink" href="#qapidoc-2684" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2685"> <h4>Example<a class="headerlink" href="#qapidoc-2685" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"closefd"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"fdname"</span><span class="p">:</span> <span class="s2">"fd1"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2689"> <h3><a class="toc-backref" href="#id510"><code class="docutils literal notranslate"><span class="pre">AddfdInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2689" title="Permalink to this headline">¶</a></h3> <p>Information about a file descriptor that was added to an fd set.</p> <div class="section" id="qapidoc-2687"> <h4>Members<a class="headerlink" href="#qapidoc-2687" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdset-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The ID of the fd set that <code class="docutils literal notranslate"><span class="pre">fd</span></code> was added to.</dd> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The file descriptor that was received via SCM rights and added to the fd set.</dd> </dl> </div> <div class="section" id="qapidoc-2688"> <h4>Since<a class="headerlink" href="#qapidoc-2688" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2695"> <h3><a class="toc-backref" href="#id511"><code class="docutils literal notranslate"><span class="pre">add-fd</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2695" title="Permalink to this headline">¶</a></h3> <p>Add a file descriptor, that was passed via SCM rights, to an fd set.</p> <div class="section" id="qapidoc-2690"> <h4>Arguments<a class="headerlink" href="#qapidoc-2690" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdset-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The ID of the fd set to add the file descriptor to.</dd> <dt><code class="docutils literal notranslate"><span class="pre">opaque</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>A free-form string that can be used to describe the fd.</dd> </dl> </div> <div class="section" id="qapidoc-2691"> <h4>Returns<a class="headerlink" href="#qapidoc-2691" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li><code class="docutils literal notranslate"><span class="pre">AddfdInfo</span></code> on success</li> <li>If file descriptor was not received, FdNotSupplied</li> <li>If <code class="docutils literal notranslate"><span class="pre">fdset-id</span></code> is a negative value, InvalidParameterValue</li> </ul> </div> <div class="section" id="qapidoc-2692"> <h4>Notes<a class="headerlink" href="#qapidoc-2692" title="Permalink to this headline">¶</a></h4> <p>The list of fd sets is shared by all monitor connections.</p> <p>If <code class="docutils literal notranslate"><span class="pre">fdset-id</span></code> is not specified, a new fd set will be created.</p> </div> <div class="section" id="qapidoc-2693"> <h4>Since<a class="headerlink" href="#qapidoc-2693" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2694"> <h4>Example<a class="headerlink" href="#qapidoc-2694" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"add-fd"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"fdset-id"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"fdset-id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">3</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2701"> <h3><a class="toc-backref" href="#id512"><code class="docutils literal notranslate"><span class="pre">remove-fd</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2701" title="Permalink to this headline">¶</a></h3> <p>Remove a file descriptor from an fd set.</p> <div class="section" id="qapidoc-2696"> <h4>Arguments<a class="headerlink" href="#qapidoc-2696" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdset-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The ID of the fd set that the file descriptor belongs to.</dd> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>The file descriptor that is to be removed.</dd> </dl> </div> <div class="section" id="qapidoc-2697"> <h4>Returns<a class="headerlink" href="#qapidoc-2697" title="Permalink to this headline">¶</a></h4> <ul class="simple"> <li>Nothing on success</li> <li>If <code class="docutils literal notranslate"><span class="pre">fdset-id</span></code> or <code class="docutils literal notranslate"><span class="pre">fd</span></code> is not found, FdNotFound</li> </ul> </div> <div class="section" id="qapidoc-2698"> <h4>Since<a class="headerlink" href="#qapidoc-2698" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2699"> <h4>Notes<a class="headerlink" href="#qapidoc-2699" title="Permalink to this headline">¶</a></h4> <p>The list of fd sets is shared by all monitor connections.</p> <p>If <code class="docutils literal notranslate"><span class="pre">fd</span></code> is not specified, all file descriptors in <code class="docutils literal notranslate"><span class="pre">fdset-id</span></code> will be removed.</p> </div> <div class="section" id="qapidoc-2700"> <h4>Example<a class="headerlink" href="#qapidoc-2700" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"remove-fd"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"fdset-id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">3</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2704"> <h3><a class="toc-backref" href="#id513"><code class="docutils literal notranslate"><span class="pre">FdsetFdInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2704" title="Permalink to this headline">¶</a></h3> <p>Information about a file descriptor that belongs to an fd set.</p> <div class="section" id="qapidoc-2702"> <h4>Members<a class="headerlink" href="#qapidoc-2702" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fd</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The file descriptor value.</dd> <dt><code class="docutils literal notranslate"><span class="pre">opaque</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>A free-form string that can be used to describe the fd.</dd> </dl> </div> <div class="section" id="qapidoc-2703"> <h4>Since<a class="headerlink" href="#qapidoc-2703" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2707"> <h3><a class="toc-backref" href="#id514"><code class="docutils literal notranslate"><span class="pre">FdsetInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2707" title="Permalink to this headline">¶</a></h3> <p>Information about an fd set.</p> <div class="section" id="qapidoc-2705"> <h4>Members<a class="headerlink" href="#qapidoc-2705" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">fdset-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The ID of the fd set.</dd> <dt><code class="docutils literal notranslate"><span class="pre">fds</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">FdsetFdInfo</span></code></dt> <dd>A list of file descriptors that belong to this fd set.</dd> </dl> </div> <div class="section" id="qapidoc-2706"> <h4>Since<a class="headerlink" href="#qapidoc-2706" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> </div> <div class="section" id="qapidoc-2712"> <h3><a class="toc-backref" href="#id515"><code class="docutils literal notranslate"><span class="pre">query-fdsets</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2712" title="Permalink to this headline">¶</a></h3> <p>Return information describing all fd sets.</p> <div class="section" id="qapidoc-2708"> <h4>Returns<a class="headerlink" href="#qapidoc-2708" title="Permalink to this headline">¶</a></h4> <p>A list of <code class="docutils literal notranslate"><span class="pre">FdsetInfo</span></code></p> </div> <div class="section" id="qapidoc-2709"> <h4>Since<a class="headerlink" href="#qapidoc-2709" title="Permalink to this headline">¶</a></h4> <p>1.2</p> </div> <div class="section" id="qapidoc-2710"> <h4>Note<a class="headerlink" href="#qapidoc-2710" title="Permalink to this headline">¶</a></h4> <p>The list of fd sets is shared by all monitor connections.</p> </div> <div class="section" id="qapidoc-2711"> <h4>Example<a class="headerlink" href="#qapidoc-2711" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-fdsets"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"fds"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">30</span><span class="p">,</span> <span class="s2">"opaque"</span><span class="p">:</span> <span class="s2">"rdonly:/path/to/file"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">24</span><span class="p">,</span> <span class="s2">"opaque"</span><span class="p">:</span> <span class="s2">"rdwr:/path/to/file"</span> <span class="p">}</span> <span class="p">],</span> <span class="s2">"fdset-id"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"fds"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">28</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"fd"</span><span class="p">:</span> <span class="mi">29</span> <span class="p">}</span> <span class="p">],</span> <span class="s2">"fdset-id"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2715"> <h3><a class="toc-backref" href="#id516"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2715" title="Permalink to this headline">¶</a></h3> <p>Possible types for an option parameter.</p> <div class="section" id="qapidoc-2713"> <h4>Values<a class="headerlink" href="#qapidoc-2713" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>accepts a character string</dd> <dt><code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>accepts “on” or “off”</dd> <dt><code class="docutils literal notranslate"><span class="pre">number</span></code></dt> <dd>accepts a number</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code></dt> <dd>accepts a number followed by an optional suffix (K)ilo, (M)ega, (G)iga, (T)era</dd> </dl> </div> <div class="section" id="qapidoc-2714"> <h4>Since<a class="headerlink" href="#qapidoc-2714" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2718"> <h3><a class="toc-backref" href="#id517"><code class="docutils literal notranslate"><span class="pre">CommandLineParameterInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2718" title="Permalink to this headline">¶</a></h3> <p>Details about a single parameter of a command line option.</p> <div class="section" id="qapidoc-2716"> <h4>Members<a class="headerlink" href="#qapidoc-2716" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>parameter name</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">CommandLineParameterType</span></code></dt> <dd>parameter <code class="docutils literal notranslate"><span class="pre">CommandLineParameterType</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">help</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>human readable text string, not suitable for parsing.</dd> <dt><code class="docutils literal notranslate"><span class="pre">default</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>default value string (since 2.1)</dd> </dl> </div> <div class="section" id="qapidoc-2717"> <h4>Since<a class="headerlink" href="#qapidoc-2717" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2721"> <h3><a class="toc-backref" href="#id518"><code class="docutils literal notranslate"><span class="pre">CommandLineOptionInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2721" title="Permalink to this headline">¶</a></h3> <p>Details about a command line option, including its list of parameter details</p> <div class="section" id="qapidoc-2719"> <h4>Members<a class="headerlink" href="#qapidoc-2719" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">option</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>option name</dd> <dt><code class="docutils literal notranslate"><span class="pre">parameters</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">CommandLineParameterInfo</span></code></dt> <dd>an array of <code class="docutils literal notranslate"><span class="pre">CommandLineParameterInfo</span></code></dd> </dl> </div> <div class="section" id="qapidoc-2720"> <h4>Since<a class="headerlink" href="#qapidoc-2720" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2726"> <h3><a class="toc-backref" href="#id519"><code class="docutils literal notranslate"><span class="pre">query-command-line-options</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2726" title="Permalink to this headline">¶</a></h3> <p>Query command line option schema.</p> <div class="section" id="qapidoc-2722"> <h4>Arguments<a class="headerlink" href="#qapidoc-2722" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">option</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>option name</dd> </dl> </div> <div class="section" id="qapidoc-2723"> <h4>Returns<a class="headerlink" href="#qapidoc-2723" title="Permalink to this headline">¶</a></h4> <p>list of <code class="docutils literal notranslate"><span class="pre">CommandLineOptionInfo</span></code> for all options (or for the given <code class="docutils literal notranslate"><span class="pre">option</span></code>). Returns an error if the given <code class="docutils literal notranslate"><span class="pre">option</span></code> doesn’t exist.</p> </div> <div class="section" id="qapidoc-2724"> <h4>Since<a class="headerlink" href="#qapidoc-2724" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> <div class="section" id="qapidoc-2725"> <h4>Example<a class="headerlink" href="#qapidoc-2725" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-command-line-options"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"option"</span><span class="p">:</span> <span class="s2">"option-rom"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"romfile"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"string"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bootindex"</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"number"</span> <span class="p">}</span> <span class="p">],</span> <span class="s2">"option"</span><span class="p">:</span> <span class="s2">"option-rom"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2732"> <h3><a class="toc-backref" href="#id520"><code class="docutils literal notranslate"><span class="pre">RTC_CHANGE</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2732" title="Permalink to this headline">¶</a></h3> <p>Emitted when the guest changes the RTC time.</p> <div class="section" id="qapidoc-2727"> <h4>Arguments<a class="headerlink" href="#qapidoc-2727" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">offset</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>offset between base RTC clock (as specified by -rtc base), and new RTC clock value</dd> </dl> </div> <div class="section" id="qapidoc-2728"> <h4>Note<a class="headerlink" href="#qapidoc-2728" title="Permalink to this headline">¶</a></h4> <p>This event is rate-limited.</p> </div> <div class="section" id="qapidoc-2729"> <h4>Since<a class="headerlink" href="#qapidoc-2729" title="Permalink to this headline">¶</a></h4> <p>0.13</p> </div> <div class="section" id="qapidoc-2730"> <h4>Example<a class="headerlink" href="#qapidoc-2730" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"RTC_CHANGE"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"offset"</span><span class="p">:</span> <span class="mi">78</span> <span class="p">},</span> <span class="s2">"timestamp"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">1267020223</span><span class="p">,</span> <span class="s2">"microseconds"</span><span class="p">:</span> <span class="mi">435656</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2731"> <h4>If<a class="headerlink" href="#qapidoc-2731" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_ALPHA</span> <span class="pre">or</span> <span class="pre">TARGET_ARM</span> <span class="pre">or</span> <span class="pre">TARGET_HPPA</span> <span class="pre">or</span> <span class="pre">TARGET_I386</span> <span class="pre">or</span> <span class="pre">TARGET_MIPS</span> <span class="pre">or</span> <span class="pre">TARGET_MIPS64</span> <span class="pre">or</span> <span class="pre">TARGET_PPC</span> <span class="pre">or</span> <span class="pre">TARGET_PPC64</span> <span class="pre">or</span> <span class="pre">TARGET_S390X</span> <span class="pre">or</span> <span class="pre">TARGET_SH4</span> <span class="pre">or</span> <span class="pre">TARGET_SPARC</span></code></p> </div> </div> <div class="section" id="qapidoc-2736"> <h3><a class="toc-backref" href="#id521"><code class="docutils literal notranslate"><span class="pre">rtc-reset-reinjection</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2736" title="Permalink to this headline">¶</a></h3> <p>This command will reset the RTC interrupt reinjection backlog. Can be used if another mechanism to synchronize guest time is in effect, for example QEMU guest agent’s guest-set-time command.</p> <div class="section" id="qapidoc-2733"> <h4>Since<a class="headerlink" href="#qapidoc-2733" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-2734"> <h4>Example<a class="headerlink" href="#qapidoc-2734" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"rtc-reset-reinjection"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2735"> <h4>If<a class="headerlink" href="#qapidoc-2735" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2740"> <h3><a class="toc-backref" href="#id522"><code class="docutils literal notranslate"><span class="pre">SevState</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2740" title="Permalink to this headline">¶</a></h3> <p>An enumeration of SEV state information used during <code class="docutils literal notranslate"><span class="pre">query-sev</span></code>.</p> <div class="section" id="qapidoc-2737"> <h4>Values<a class="headerlink" href="#qapidoc-2737" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">uninit</span></code></dt> <dd>The guest is uninitialized.</dd> <dt><code class="docutils literal notranslate"><span class="pre">launch-update</span></code></dt> <dd>The guest is currently being launched; plaintext data and register state is being imported.</dd> <dt><code class="docutils literal notranslate"><span class="pre">launch-secret</span></code></dt> <dd>The guest is currently being launched; ciphertext data is being imported.</dd> <dt><code class="docutils literal notranslate"><span class="pre">running</span></code></dt> <dd>The guest is fully launched or migrated in.</dd> <dt><code class="docutils literal notranslate"><span class="pre">send-update</span></code></dt> <dd>The guest is currently being migrated out to another machine.</dd> <dt><code class="docutils literal notranslate"><span class="pre">receive-update</span></code></dt> <dd>The guest is currently being migrated from another machine.</dd> </dl> </div> <div class="section" id="qapidoc-2738"> <h4>Since<a class="headerlink" href="#qapidoc-2738" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2739"> <h4>If<a class="headerlink" href="#qapidoc-2739" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2744"> <h3><a class="toc-backref" href="#id523"><code class="docutils literal notranslate"><span class="pre">SevInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2744" title="Permalink to this headline">¶</a></h3> <p>Information about Secure Encrypted Virtualization (SEV) support</p> <div class="section" id="qapidoc-2741"> <h4>Members<a class="headerlink" href="#qapidoc-2741" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">enabled</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if SEV is active</dd> <dt><code class="docutils literal notranslate"><span class="pre">api-major</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SEV API major version</dd> <dt><code class="docutils literal notranslate"><span class="pre">api-minor</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SEV API minor version</dd> <dt><code class="docutils literal notranslate"><span class="pre">build-id</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SEV FW build id</dd> <dt><code class="docutils literal notranslate"><span class="pre">policy</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SEV policy value</dd> <dt><code class="docutils literal notranslate"><span class="pre">state</span></code>: <code class="docutils literal notranslate"><span class="pre">SevState</span></code></dt> <dd>SEV guest state</dd> <dt><code class="docutils literal notranslate"><span class="pre">handle</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>SEV firmware handle</dd> </dl> </div> <div class="section" id="qapidoc-2742"> <h4>Since<a class="headerlink" href="#qapidoc-2742" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2743"> <h4>If<a class="headerlink" href="#qapidoc-2743" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2749"> <h3><a class="toc-backref" href="#id524"><code class="docutils literal notranslate"><span class="pre">query-sev</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2749" title="Permalink to this headline">¶</a></h3> <p>Returns information about SEV</p> <div class="section" id="qapidoc-2745"> <h4>Returns<a class="headerlink" href="#qapidoc-2745" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">SevInfo</span></code></p> </div> <div class="section" id="qapidoc-2746"> <h4>Since<a class="headerlink" href="#qapidoc-2746" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2747"> <h4>Example<a class="headerlink" href="#qapidoc-2747" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-sev"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"api-major"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"api-minor"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"build-id"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"policy"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"state"</span> <span class="p">:</span> <span class="s2">"running"</span><span class="p">,</span> <span class="s2">"handle"</span> <span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2748"> <h4>If<a class="headerlink" href="#qapidoc-2748" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2753"> <h3><a class="toc-backref" href="#id525"><code class="docutils literal notranslate"><span class="pre">SevLaunchMeasureInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2753" title="Permalink to this headline">¶</a></h3> <p>SEV Guest Launch measurement information</p> <div class="section" id="qapidoc-2750"> <h4>Members<a class="headerlink" href="#qapidoc-2750" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the measurement value encoded in base64</dd> </dl> </div> <div class="section" id="qapidoc-2751"> <h4>Since<a class="headerlink" href="#qapidoc-2751" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2752"> <h4>If<a class="headerlink" href="#qapidoc-2752" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2758"> <h3><a class="toc-backref" href="#id526"><code class="docutils literal notranslate"><span class="pre">query-sev-launch-measure</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2758" title="Permalink to this headline">¶</a></h3> <p>Query the SEV guest launch information.</p> <div class="section" id="qapidoc-2754"> <h4>Returns<a class="headerlink" href="#qapidoc-2754" title="Permalink to this headline">¶</a></h4> <p>The <code class="docutils literal notranslate"><span class="pre">SevLaunchMeasureInfo</span></code> for the guest</p> </div> <div class="section" id="qapidoc-2755"> <h4>Since<a class="headerlink" href="#qapidoc-2755" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2756"> <h4>Example<a class="headerlink" href="#qapidoc-2756" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-sev-launch-measure"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"4l8LXeNlSPUDlXPJG5966/8%YZ"</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2757"> <h4>If<a class="headerlink" href="#qapidoc-2757" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2762"> <h3><a class="toc-backref" href="#id527"><code class="docutils literal notranslate"><span class="pre">SevCapability</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2762" title="Permalink to this headline">¶</a></h3> <p>The struct describes capability for a Secure Encrypted Virtualization feature.</p> <div class="section" id="qapidoc-2759"> <h4>Members<a class="headerlink" href="#qapidoc-2759" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">pdh</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>Platform Diffie-Hellman key (base64 encoded)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cert-chain</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>PDH certificate chain (base64 encoded)</dd> <dt><code class="docutils literal notranslate"><span class="pre">cbitpos</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>C-bit location in page table entry</dd> <dt><code class="docutils literal notranslate"><span class="pre">reduced-phys-bits</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Number of physical Address bit reduction when SEV is enabled</dd> </dl> </div> <div class="section" id="qapidoc-2760"> <h4>Since<a class="headerlink" href="#qapidoc-2760" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2761"> <h4>If<a class="headerlink" href="#qapidoc-2761" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2767"> <h3><a class="toc-backref" href="#id528"><code class="docutils literal notranslate"><span class="pre">query-sev-capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2767" title="Permalink to this headline">¶</a></h3> <p>This command is used to get the SEV capabilities, and is supported on AMD X86 platforms only.</p> <div class="section" id="qapidoc-2763"> <h4>Returns<a class="headerlink" href="#qapidoc-2763" title="Permalink to this headline">¶</a></h4> <p>SevCapability objects.</p> </div> <div class="section" id="qapidoc-2764"> <h4>Since<a class="headerlink" href="#qapidoc-2764" title="Permalink to this headline">¶</a></h4> <p>2.12</p> </div> <div class="section" id="qapidoc-2765"> <h4>Example<a class="headerlink" href="#qapidoc-2765" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-sev-capabilities"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"pdh"</span><span class="p">:</span> <span class="s2">"8CCDD8DDD"</span><span class="p">,</span> <span class="s2">"cert-chain"</span><span class="p">:</span> <span class="s2">"888CCCDDDEE"</span><span class="p">,</span> <span class="s2">"cbitpos"</span><span class="p">:</span> <span class="mi">47</span><span class="p">,</span> <span class="s2">"reduced-phys-bits"</span><span class="p">:</span> <span class="mi">1</span><span class="p">}}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2766"> <h4>If<a class="headerlink" href="#qapidoc-2766" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2771"> <h3><a class="toc-backref" href="#id529"><code class="docutils literal notranslate"><span class="pre">sev-inject-launch-secret</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2771" title="Permalink to this headline">¶</a></h3> <p>This command injects a secret blob into memory of SEV guest.</p> <div class="section" id="qapidoc-2768"> <h4>Arguments<a class="headerlink" href="#qapidoc-2768" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">packet-header</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the launch secret packet header encoded in base64</dd> <dt><code class="docutils literal notranslate"><span class="pre">secret</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the launch secret data to be injected encoded in base64</dd> <dt><code class="docutils literal notranslate"><span class="pre">gpa</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the guest physical address where secret will be injected.</dd> </dl> </div> <div class="section" id="qapidoc-2769"> <h4>Since<a class="headerlink" href="#qapidoc-2769" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> <div class="section" id="qapidoc-2770"> <h4>If<a class="headerlink" href="#qapidoc-2770" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2775"> <h3><a class="toc-backref" href="#id530"><code class="docutils literal notranslate"><span class="pre">SevAttestationReport</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2775" title="Permalink to this headline">¶</a></h3> <p>The struct describes attestation report for a Secure Encrypted Virtualization feature.</p> <div class="section" id="qapidoc-2772"> <h4>Members<a class="headerlink" href="#qapidoc-2772" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>guest attestation report (base64 encoded)</dd> </dl> </div> <div class="section" id="qapidoc-2773"> <h4>Since<a class="headerlink" href="#qapidoc-2773" title="Permalink to this headline">¶</a></h4> <p>6.1</p> </div> <div class="section" id="qapidoc-2774"> <h4>If<a class="headerlink" href="#qapidoc-2774" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2781"> <h3><a class="toc-backref" href="#id531"><code class="docutils literal notranslate"><span class="pre">query-sev-attestation-report</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2781" title="Permalink to this headline">¶</a></h3> <p>This command is used to get the SEV attestation report, and is supported on AMD X86 platforms only.</p> <div class="section" id="qapidoc-2776"> <h4>Arguments<a class="headerlink" href="#qapidoc-2776" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mnonce</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>a random 16 bytes value encoded in base64 (it will be included in report)</dd> </dl> </div> <div class="section" id="qapidoc-2777"> <h4>Returns<a class="headerlink" href="#qapidoc-2777" title="Permalink to this headline">¶</a></h4> <p>SevAttestationReport objects.</p> </div> <div class="section" id="qapidoc-2778"> <h4>Since<a class="headerlink" href="#qapidoc-2778" title="Permalink to this headline">¶</a></h4> <p>6.1</p> </div> <div class="section" id="qapidoc-2779"> <h4>Example<a class="headerlink" href="#qapidoc-2779" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span> <span class="p">:</span> <span class="s2">"query-sev-attestation-report"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"mnonce"</span><span class="p">:</span> <span class="s2">"aaaaaaa"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span> <span class="p">:</span> <span class="p">{</span> <span class="s2">"data"</span><span class="p">:</span> <span class="s2">"aaaaaaaabbbddddd"</span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2780"> <h4>If<a class="headerlink" href="#qapidoc-2780" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2787"> <h3><a class="toc-backref" href="#id532"><code class="docutils literal notranslate"><span class="pre">dump-skeys</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2787" title="Permalink to this headline">¶</a></h3> <p>Dump guest’s storage keys</p> <div class="section" id="qapidoc-2782"> <h4>Arguments<a class="headerlink" href="#qapidoc-2782" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">filename</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the path to the file to dump to</dd> </dl> </div> <div class="section" id="qapidoc-2783"> This command is only supported on s390 architecture.</div> <div class="section" id="qapidoc-2784"> <h4>Since<a class="headerlink" href="#qapidoc-2784" title="Permalink to this headline">¶</a></h4> <p>2.5</p> </div> <div class="section" id="qapidoc-2785"> <h4>Example<a class="headerlink" href="#qapidoc-2785" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"dump-skeys"</span><span class="p">,</span> <span class="s2">"arguments"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"filename"</span><span class="p">:</span> <span class="s2">"/tmp/skeys"</span> <span class="p">}</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2786"> <h4>If<a class="headerlink" href="#qapidoc-2786" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_S390X</span></code></p> </div> </div> <div class="section" id="qapidoc-2791"> <h3><a class="toc-backref" href="#id533"><code class="docutils literal notranslate"><span class="pre">GICCapability</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2791" title="Permalink to this headline">¶</a></h3> <p>The struct describes capability for a specific GIC (Generic Interrupt Controller) version. These bits are not only decided by QEMU/KVM software version, but also decided by the hardware that the program is running upon.</p> <div class="section" id="qapidoc-2788"> <h4>Members<a class="headerlink" href="#qapidoc-2788" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">version</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>version of GIC to be described. Currently, only 2 and 3 are supported.</dd> <dt><code class="docutils literal notranslate"><span class="pre">emulated</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether current QEMU/hardware supports emulated GIC device in user space.</dd> <dt><code class="docutils literal notranslate"><span class="pre">kernel</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>whether current QEMU/hardware supports hardware accelerated GIC device in kernel.</dd> </dl> </div> <div class="section" id="qapidoc-2789"> <h4>Since<a class="headerlink" href="#qapidoc-2789" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-2790"> <h4>If<a class="headerlink" href="#qapidoc-2790" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_ARM</span></code></p> </div> </div> <div class="section" id="qapidoc-2796"> <h3><a class="toc-backref" href="#id534"><code class="docutils literal notranslate"><span class="pre">query-gic-capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2796" title="Permalink to this headline">¶</a></h3> <p>This command is ARM-only. It will return a list of GICCapability objects that describe its capability bits.</p> <div class="section" id="qapidoc-2792"> <h4>Returns<a class="headerlink" href="#qapidoc-2792" title="Permalink to this headline">¶</a></h4> <p>a list of GICCapability objects.</p> </div> <div class="section" id="qapidoc-2793"> <h4>Since<a class="headerlink" href="#qapidoc-2793" title="Permalink to this headline">¶</a></h4> <p>2.6</p> </div> <div class="section" id="qapidoc-2794"> <h4>Example<a class="headerlink" href="#qapidoc-2794" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-gic-capabilities"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[{</span> <span class="s2">"version"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"emulated"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"kernel"</span><span class="p">:</span> <span class="n">false</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"version"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s2">"emulated"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"kernel"</span><span class="p">:</span> <span class="n">true</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2795"> <h4>If<a class="headerlink" href="#qapidoc-2795" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_ARM</span></code></p> </div> </div> <div class="section" id="qapidoc-2799"> <h3><a class="toc-backref" href="#id535"><code class="docutils literal notranslate"><span class="pre">SGXEPCSection</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2799" title="Permalink to this headline">¶</a></h3> <p>Information about intel SGX EPC section info</p> <div class="section" id="qapidoc-2797"> <h4>Members<a class="headerlink" href="#qapidoc-2797" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">node</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the numa node</dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the size of EPC section</dd> </dl> </div> <div class="section" id="qapidoc-2798"> <h4>Since<a class="headerlink" href="#qapidoc-2798" title="Permalink to this headline">¶</a></h4> <p>7.0</p> </div> </div> <div class="section" id="qapidoc-2804"> <h3><a class="toc-backref" href="#id536"><code class="docutils literal notranslate"><span class="pre">SGXInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2804" title="Permalink to this headline">¶</a></h3> <p>Information about intel Safe Guard eXtension (SGX) support</p> <div class="section" id="qapidoc-2800"> <h4>Members<a class="headerlink" href="#qapidoc-2800" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sgx</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if SGX is supported</dd> <dt><code class="docutils literal notranslate"><span class="pre">sgx1</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if SGX1 is supported</dd> <dt><code class="docutils literal notranslate"><span class="pre">sgx2</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if SGX2 is supported</dd> <dt><code class="docutils literal notranslate"><span class="pre">flc</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code></dt> <dd>true if FLC is supported</dd> <dt><code class="docutils literal notranslate"><span class="pre">section-size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>The EPC section size for guest Redundant with <code class="docutils literal notranslate"><span class="pre">sections</span></code>. Just for backward compatibility.</dd> <dt><code class="docutils literal notranslate"><span class="pre">sections</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">SGXEPCSection</span></code></dt> <dd>The EPC sections info for guest (Since: 7.0)</dd> </dl> </div> <div class="section" id="qapidoc-2801"> <h4>Features<a class="headerlink" href="#qapidoc-2801" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">deprecated</span></code></dt> <dd>Member <code class="docutils literal notranslate"><span class="pre">section-size</span></code> is deprecated. Use <code class="docutils literal notranslate"><span class="pre">sections</span></code> instead.</dd> </dl> </div> <div class="section" id="qapidoc-2802"> <h4>Since<a class="headerlink" href="#qapidoc-2802" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2803"> <h4>If<a class="headerlink" href="#qapidoc-2803" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2809"> <h3><a class="toc-backref" href="#id537"><code class="docutils literal notranslate"><span class="pre">query-sgx</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2809" title="Permalink to this headline">¶</a></h3> <p>Returns information about SGX</p> <div class="section" id="qapidoc-2805"> <h4>Returns<a class="headerlink" href="#qapidoc-2805" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">SGXInfo</span></code></p> </div> <div class="section" id="qapidoc-2806"> <h4>Since<a class="headerlink" href="#qapidoc-2806" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2807"> <h4>Example<a class="headerlink" href="#qapidoc-2807" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-sgx"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"sgx"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"sgx1"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"sgx2"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"flc"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"section-size"</span> <span class="p">:</span> <span class="mi">96468992</span><span class="p">,</span> <span class="s2">"sections"</span><span class="p">:</span> <span class="p">[{</span><span class="s2">"node"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">67108864</span><span class="p">},</span> <span class="p">{</span><span class="s2">"node"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">29360128</span><span class="p">}]}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2808"> <h4>If<a class="headerlink" href="#qapidoc-2808" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> <div class="section" id="qapidoc-2814"> <h3><a class="toc-backref" href="#id538"><code class="docutils literal notranslate"><span class="pre">query-sgx-capabilities</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2814" title="Permalink to this headline">¶</a></h3> <p>Returns information from host SGX capabilities</p> <div class="section" id="qapidoc-2810"> <h4>Returns<a class="headerlink" href="#qapidoc-2810" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">SGXInfo</span></code></p> </div> <div class="section" id="qapidoc-2811"> <h4>Since<a class="headerlink" href="#qapidoc-2811" title="Permalink to this headline">¶</a></h4> <p>6.2</p> </div> <div class="section" id="qapidoc-2812"> <h4>Example<a class="headerlink" href="#qapidoc-2812" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-sgx-capabilities"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"sgx"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"sgx1"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"sgx2"</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"flc"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"section-size"</span> <span class="p">:</span> <span class="mi">96468992</span><span class="p">,</span> <span class="s2">"section"</span> <span class="p">:</span> <span class="p">[{</span><span class="s2">"node"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">67108864</span><span class="p">},</span> <span class="p">{</span><span class="s2">"node"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">29360128</span><span class="p">}]}</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2813"> <h4>If<a class="headerlink" href="#qapidoc-2813" title="Permalink to this headline">¶</a></h4> <p><code class="docutils literal notranslate"><span class="pre">TARGET_I386</span></code></p> </div> </div> </div> <div class="section" id="qapidoc-2815"> <h2><a class="toc-backref" href="#id539">Audio</a><a class="headerlink" href="#qapidoc-2815" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2818"> <h3><a class="toc-backref" href="#id540"><code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2818" title="Permalink to this headline">¶</a></h3> <p>General audio backend options that are used for both playback and recording.</p> <div class="section" id="qapidoc-2816"> <h4>Members<a class="headerlink" href="#qapidoc-2816" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">mixing-engine</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>use QEMU’s mixing engine to mix all streams inside QEMU and convert audio formats when not supported by the backend. When set to off, fixed-settings must be also off (default on, since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">fixed-settings</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>use fixed settings for host input/output. When off, frequency, channels and format must not be specified (default true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">frequency</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>frequency to use when using fixed settings (default 44100)</dd> <dt><code class="docutils literal notranslate"><span class="pre">channels</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of channels when using fixed settings (default 2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">voices</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of voices to use (default 1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">format</span></code>: <code class="docutils literal notranslate"><span class="pre">AudioFormat</span></code> (optional)</dt> <dd>sample format to use when using fixed settings (default s16)</dd> <dt><code class="docutils literal notranslate"><span class="pre">buffer-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the buffer length in microseconds</dd> </dl> </div> <div class="section" id="qapidoc-2817"> <h4>Since<a class="headerlink" href="#qapidoc-2817" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2821"> <h3><a class="toc-backref" href="#id541"><code class="docutils literal notranslate"><span class="pre">AudiodevGenericOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2821" title="Permalink to this headline">¶</a></h3> <p>Generic driver-specific options.</p> <div class="section" id="qapidoc-2819"> <h4>Members<a class="headerlink" href="#qapidoc-2819" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> </dl> </div> <div class="section" id="qapidoc-2820"> <h4>Since<a class="headerlink" href="#qapidoc-2820" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2824"> <h3><a class="toc-backref" href="#id542"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2824" title="Permalink to this headline">¶</a></h3> <p>Options of the ALSA backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2822"> <h4>Members<a class="headerlink" href="#qapidoc-2822" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the name of the ALSA device to use (default ‘default’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">period-length</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the period length in microseconds</dd> <dt><code class="docutils literal notranslate"><span class="pre">try-poll</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>attempt to use poll mode, falling back to non-polling access on failure (default true)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2823"> <h4>Since<a class="headerlink" href="#qapidoc-2823" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2827"> <h3><a class="toc-backref" href="#id543"><code class="docutils literal notranslate"><span class="pre">AudiodevAlsaOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2827" title="Permalink to this headline">¶</a></h3> <p>Options of the ALSA audio backend.</p> <div class="section" id="qapidoc-2825"> <h4>Members<a class="headerlink" href="#qapidoc-2825" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevAlsaPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevAlsaPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">threshold</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set the threshold (in microseconds) when playback starts</dd> </dl> </div> <div class="section" id="qapidoc-2826"> <h4>Since<a class="headerlink" href="#qapidoc-2826" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2830"> <h3><a class="toc-backref" href="#id544"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2830" title="Permalink to this headline">¶</a></h3> <p>Options of the Core Audio backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2828"> <h4>Members<a class="headerlink" href="#qapidoc-2828" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">buffer-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of buffers</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2829"> <h4>Since<a class="headerlink" href="#qapidoc-2829" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2833"> <h3><a class="toc-backref" href="#id545"><code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2833" title="Permalink to this headline">¶</a></h3> <p>Options of the coreaudio audio backend.</p> <div class="section" id="qapidoc-2831"> <h4>Members<a class="headerlink" href="#qapidoc-2831" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> </dl> </div> <div class="section" id="qapidoc-2832"> <h4>Since<a class="headerlink" href="#qapidoc-2832" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2836"> <h3><a class="toc-backref" href="#id546"><code class="docutils literal notranslate"><span class="pre">AudiodevDsoundOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2836" title="Permalink to this headline">¶</a></h3> <p>Options of the DirectSound audio backend.</p> <div class="section" id="qapidoc-2834"> <h4>Members<a class="headerlink" href="#qapidoc-2834" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">latency</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>add extra latency to playback in microseconds (default 10000)</dd> </dl> </div> <div class="section" id="qapidoc-2835"> <h4>Since<a class="headerlink" href="#qapidoc-2835" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2839"> <h3><a class="toc-backref" href="#id547"><code class="docutils literal notranslate"><span class="pre">AudiodevJackPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2839" title="Permalink to this headline">¶</a></h3> <p>Options of the JACK backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2837"> <h4>Members<a class="headerlink" href="#qapidoc-2837" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">server-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>select from among several possible concurrent server instances (default: environment variable $JACK_DEFAULT_SERVER if set, else “default”)</dd> <dt><code class="docutils literal notranslate"><span class="pre">client-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>the client name to use. The server will modify this name to create a unique variant, if needed unless <code class="docutils literal notranslate"><span class="pre">exact-name</span></code> is true (default: the guest’s name)</dd> <dt><code class="docutils literal notranslate"><span class="pre">connect-ports</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>if set, a regular expression of JACK client port name(s) to monitor for and automatically connect to</dd> <dt><code class="docutils literal notranslate"><span class="pre">start-server</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>start a jack server process if one is not already present (default: false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">exact-name</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>use the exact name requested otherwise JACK automatically generates a unique one, if needed (default: false)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2838"> <h4>Since<a class="headerlink" href="#qapidoc-2838" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-2842"> <h3><a class="toc-backref" href="#id548"><code class="docutils literal notranslate"><span class="pre">AudiodevJackOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2842" title="Permalink to this headline">¶</a></h3> <p>Options of the JACK audio backend.</p> <div class="section" id="qapidoc-2840"> <h4>Members<a class="headerlink" href="#qapidoc-2840" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevJackPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevJackPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> </dl> </div> <div class="section" id="qapidoc-2841"> <h4>Since<a class="headerlink" href="#qapidoc-2841" title="Permalink to this headline">¶</a></h4> <p>5.1</p> </div> </div> <div class="section" id="qapidoc-2845"> <h3><a class="toc-backref" href="#id549"><code class="docutils literal notranslate"><span class="pre">AudiodevOssPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2845" title="Permalink to this headline">¶</a></h3> <p>Options of the OSS backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2843"> <h4>Members<a class="headerlink" href="#qapidoc-2843" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">dev</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>file name of the OSS device (default ‘/dev/dsp’)</dd> <dt><code class="docutils literal notranslate"><span class="pre">buffer-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of buffers</dd> <dt><code class="docutils literal notranslate"><span class="pre">try-poll</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>attempt to use poll mode, falling back to non-polling access on failure (default true)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2844"> <h4>Since<a class="headerlink" href="#qapidoc-2844" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2848"> <h3><a class="toc-backref" href="#id550"><code class="docutils literal notranslate"><span class="pre">AudiodevOssOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2848" title="Permalink to this headline">¶</a></h3> <p>Options of the OSS audio backend.</p> <div class="section" id="qapidoc-2846"> <h4>Members<a class="headerlink" href="#qapidoc-2846" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevOssPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevOssPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">try-mmap</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>try using memory-mapped access, falling back to non-memory-mapped access on failure (default true)</dd> <dt><code class="docutils literal notranslate"><span class="pre">exclusive</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>open device in exclusive mode (vmix won’t work) (default false)</dd> <dt><code class="docutils literal notranslate"><span class="pre">dsp-policy</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>set the timing policy of the device (between 0 and 10, where smaller number means smaller latency but higher CPU usage) or -1 to use fragment mode (option ignored on some platforms) (default 5)</dd> </dl> </div> <div class="section" id="qapidoc-2847"> <h4>Since<a class="headerlink" href="#qapidoc-2847" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2851"> <h3><a class="toc-backref" href="#id551"><code class="docutils literal notranslate"><span class="pre">AudiodevPaPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2851" title="Permalink to this headline">¶</a></h3> <p>Options of the Pulseaudio backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2849"> <h4>Members<a class="headerlink" href="#qapidoc-2849" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the sink/source to use</dd> <dt><code class="docutils literal notranslate"><span class="pre">stream-name</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the PulseAudio stream created by qemu. Can be used to identify the stream in PulseAudio when you create multiple PulseAudio devices or run multiple qemu instances (default: audiodev’s id, since 4.2)</dd> <dt><code class="docutils literal notranslate"><span class="pre">latency</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>latency you want PulseAudio to achieve in microseconds (default 15000)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2850"> <h4>Since<a class="headerlink" href="#qapidoc-2850" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2854"> <h3><a class="toc-backref" href="#id552"><code class="docutils literal notranslate"><span class="pre">AudiodevPaOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2854" title="Permalink to this headline">¶</a></h3> <p>Options of the PulseAudio audio backend.</p> <div class="section" id="qapidoc-2852"> <h4>Members<a class="headerlink" href="#qapidoc-2852" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPaPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPaPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">server</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>PulseAudio server address (default: let PulseAudio choose)</dd> </dl> </div> <div class="section" id="qapidoc-2853"> <h4>Since<a class="headerlink" href="#qapidoc-2853" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2857"> <h3><a class="toc-backref" href="#id553"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlPerDirectionOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2857" title="Permalink to this headline">¶</a></h3> <p>Options of the SDL audio backend that are used for both playback and recording.</p> <div class="section" id="qapidoc-2855"> <h4>Members<a class="headerlink" href="#qapidoc-2855" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">buffer-count</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>number of buffers (default 4)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code></dl> </div> <div class="section" id="qapidoc-2856"> <h4>Since<a class="headerlink" href="#qapidoc-2856" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2860"> <h3><a class="toc-backref" href="#id554"><code class="docutils literal notranslate"><span class="pre">AudiodevSdlOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2860" title="Permalink to this headline">¶</a></h3> <p>Options of the SDL audio backend.</p> <div class="section" id="qapidoc-2858"> <h4>Members<a class="headerlink" href="#qapidoc-2858" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevSdlPerDirectionOptions</span></code> (optional)</dt> <dd>options of the recording stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevSdlPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> </dl> </div> <div class="section" id="qapidoc-2859"> <h4>Since<a class="headerlink" href="#qapidoc-2859" title="Permalink to this headline">¶</a></h4> <p>6.0</p> </div> </div> <div class="section" id="qapidoc-2863"> <h3><a class="toc-backref" href="#id555"><code class="docutils literal notranslate"><span class="pre">AudiodevWavOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2863" title="Permalink to this headline">¶</a></h3> <p>Options of the wav audio backend.</p> <div class="section" id="qapidoc-2861"> <h4>Members<a class="headerlink" href="#qapidoc-2861" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">in</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the capture stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">out</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevPerDirectionOptions</span></code> (optional)</dt> <dd>options of the playback stream</dd> <dt><code class="docutils literal notranslate"><span class="pre">path</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>name of the wav file to record (default ‘qemu.wav’)</dd> </dl> </div> <div class="section" id="qapidoc-2862"> <h4>Since<a class="headerlink" href="#qapidoc-2862" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2866"> <h3><a class="toc-backref" href="#id556"><code class="docutils literal notranslate"><span class="pre">AudioFormat</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2866" title="Permalink to this headline">¶</a></h3> <p>An enumeration of possible audio formats.</p> <div class="section" id="qapidoc-2864"> <h4>Values<a class="headerlink" href="#qapidoc-2864" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">u8</span></code></dt> <dd>unsigned 8 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">s8</span></code></dt> <dd>signed 8 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">u16</span></code></dt> <dd>unsigned 16 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">s16</span></code></dt> <dd>signed 16 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">u32</span></code></dt> <dd>unsigned 32 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">s32</span></code></dt> <dd>signed 32 bit integer</dd> <dt><code class="docutils literal notranslate"><span class="pre">f32</span></code></dt> <dd>single precision floating-point (since 5.0)</dd> </dl> </div> <div class="section" id="qapidoc-2865"> <h4>Since<a class="headerlink" href="#qapidoc-2865" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2869"> <h3><a class="toc-backref" href="#id557"><code class="docutils literal notranslate"><span class="pre">AudiodevDriver</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2869" title="Permalink to this headline">¶</a></h3> <p>An enumeration of possible audio backend drivers.</p> <div class="section" id="qapidoc-2867"> <h4>Values<a class="headerlink" href="#qapidoc-2867" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">jack</span></code></dt> <dd>JACK audio backend (since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">none</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">alsa</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">coreaudio</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">dsound</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">oss</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">pa</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">sdl</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">spice</span></code></dt> <dd>Not documented</dd> <dt><code class="docutils literal notranslate"><span class="pre">wav</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2868"> <h4>Since<a class="headerlink" href="#qapidoc-2868" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> <div class="section" id="qapidoc-2872"> <h3><a class="toc-backref" href="#id558"><code class="docutils literal notranslate"><span class="pre">Audiodev</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2872" title="Permalink to this headline">¶</a></h3> <p>Options of an audio backend.</p> <div class="section" id="qapidoc-2870"> <h4>Members<a class="headerlink" href="#qapidoc-2870" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>identifier of the backend</dd> <dt><code class="docutils literal notranslate"><span class="pre">driver</span></code>: <code class="docutils literal notranslate"><span class="pre">AudiodevDriver</span></code></dt> <dd>the backend driver to use</dd> <dt><code class="docutils literal notranslate"><span class="pre">timer-period</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>timer period (in microseconds, 0: use lowest possible)</dd> <dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevGenericOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"none"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevAlsaOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"alsa"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevCoreaudioOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"coreaudio"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevDsoundOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"dsound"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevJackOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"jack"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevOssOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"oss"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevPaOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"pa"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevSdlOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"sdl"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevGenericOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"spice"</span></code><dt>The members of <code class="docutils literal notranslate"><span class="pre">AudiodevWavOptions</span></code> when <code class="docutils literal notranslate"><span class="pre">driver</span></code> is <code class="docutils literal notranslate"><span class="pre">"wav"</span></code></dl> </div> <div class="section" id="qapidoc-2871"> <h4>Since<a class="headerlink" href="#qapidoc-2871" title="Permalink to this headline">¶</a></h4> <p>4.0</p> </div> </div> </div> <div class="section" id="qapidoc-2873"> <h2><a class="toc-backref" href="#id559">ACPI</a><a class="headerlink" href="#qapidoc-2873" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2876"> <h3><a class="toc-backref" href="#id560"><code class="docutils literal notranslate"><span class="pre">AcpiTableOptions</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2876" title="Permalink to this headline">¶</a></h3> <p>Specify an ACPI table on the command line to load.</p> <p>At most one of <code class="docutils literal notranslate"><span class="pre">file</span></code> and <code class="docutils literal notranslate"><span class="pre">data</span></code> can be specified. The list of files specified by any one of them is loaded and concatenated in order. If both are omitted, <code class="docutils literal notranslate"><span class="pre">data</span></code> is implied.</p> <p>Other fields / optargs can be used to override fields of the generic ACPI table header; refer to the ACPI specification 5.0, section 5.2.6 System Description Table Header. If a header field is not overridden, then the corresponding value from the concatenated blob is used (in case of <code class="docutils literal notranslate"><span class="pre">file</span></code>), or it is filled in with a hard-coded value (in case of <code class="docutils literal notranslate"><span class="pre">data</span></code>).</p> <p>String fields are copied into the matching ACPI member from lowest address upwards, and silently truncated / NUL-padded to length.</p> <div class="section" id="qapidoc-2874"> <h4>Members<a class="headerlink" href="#qapidoc-2874" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">sig</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>table signature / identifier (4 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">rev</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>table revision number (dependent on signature, 1 byte)</dd> <dt><code class="docutils literal notranslate"><span class="pre">oem_id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>OEM identifier (6 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">oem_table_id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>OEM table identifier (8 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">oem_rev</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>OEM-supplied revision number (4 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">asl_compiler_id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>identifier of the utility that created the table (4 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">asl_compiler_rev</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>revision number of the utility that created the table (4 bytes)</dd> <dt><code class="docutils literal notranslate"><span class="pre">file</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>colon (:) separated list of pathnames to load and concatenate as table data. The resultant binary blob is expected to have an ACPI table header. At least one file is required. This field excludes <code class="docutils literal notranslate"><span class="pre">data</span></code>.</dd> <dt><code class="docutils literal notranslate"><span class="pre">data</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>colon (:) separated list of pathnames to load and concatenate as table data. The resultant binary blob must not have an ACPI table header. At least one file is required. This field excludes <code class="docutils literal notranslate"><span class="pre">file</span></code>.</dd> </dl> </div> <div class="section" id="qapidoc-2875"> <h4>Since<a class="headerlink" href="#qapidoc-2875" title="Permalink to this headline">¶</a></h4> <p>1.5</p> </div> </div> <div class="section" id="qapidoc-2878"> <h3><a class="toc-backref" href="#id561"><code class="docutils literal notranslate"><span class="pre">ACPISlotType</span></code> (Enum)</a><a class="headerlink" href="#qapidoc-2878" title="Permalink to this headline">¶</a></h3> <div class="section" id="qapidoc-2877"> <h4>Values<a class="headerlink" href="#qapidoc-2877" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">DIMM</span></code></dt> <dd>memory slot</dd> <dt><code class="docutils literal notranslate"><span class="pre">CPU</span></code></dt> <dd>logical CPU slot (since 2.7)</dd> </dl> </div> </div> <div class="section" id="qapidoc-2881"> <h3><a class="toc-backref" href="#id562"><code class="docutils literal notranslate"><span class="pre">ACPIOSTInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2881" title="Permalink to this headline">¶</a></h3> <p>OSPM Status Indication for a device For description of possible values of <code class="docutils literal notranslate"><span class="pre">source</span></code> and <code class="docutils literal notranslate"><span class="pre">status</span></code> fields see “_OST (OSPM Status Indication)” chapter of ACPI5.0 spec.</p> <div class="section" id="qapidoc-2879"> <h4>Members<a class="headerlink" href="#qapidoc-2879" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>device ID associated with slot</dd> <dt><code class="docutils literal notranslate"><span class="pre">slot</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>slot ID, unique per slot of a given <code class="docutils literal notranslate"><span class="pre">slot-type</span></code></dd> <dt><code class="docutils literal notranslate"><span class="pre">slot-type</span></code>: <code class="docutils literal notranslate"><span class="pre">ACPISlotType</span></code></dt> <dd>type of the slot</dd> <dt><code class="docutils literal notranslate"><span class="pre">source</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>an integer containing the source event</dd> <dt><code class="docutils literal notranslate"><span class="pre">status</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>an integer containing the status code</dd> </dl> </div> <div class="section" id="qapidoc-2880"> <h4>Since<a class="headerlink" href="#qapidoc-2880" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> </div> <div class="section" id="qapidoc-2884"> <h3><a class="toc-backref" href="#id563"><code class="docutils literal notranslate"><span class="pre">query-acpi-ospm-status</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2884" title="Permalink to this headline">¶</a></h3> <p>Return a list of ACPIOSTInfo for devices that support status reporting via ACPI _OST method.</p> <div class="section" id="qapidoc-2882"> <h4>Since<a class="headerlink" href="#qapidoc-2882" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-2883"> <h4>Example<a class="headerlink" href="#qapidoc-2883" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-acpi-ospm-status"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"d1"</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"slot-type"</span><span class="p">:</span> <span class="s2">"DIMM"</span><span class="p">,</span> <span class="s2">"source"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="p">{</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> <span class="s2">"slot-type"</span><span class="p">:</span> <span class="s2">"DIMM"</span><span class="p">,</span> <span class="s2">"source"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="p">{</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> <span class="s2">"slot-type"</span><span class="p">:</span> <span class="s2">"DIMM"</span><span class="p">,</span> <span class="s2">"source"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span> <span class="p">{</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> <span class="s2">"slot-type"</span><span class="p">:</span> <span class="s2">"DIMM"</span><span class="p">,</span> <span class="s2">"source"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span> <span class="p">]}</span> </pre></div> </div> </div> </div> <div class="section" id="qapidoc-2888"> <h3><a class="toc-backref" href="#id564"><code class="docutils literal notranslate"><span class="pre">ACPI_DEVICE_OST</span></code> (Event)</a><a class="headerlink" href="#qapidoc-2888" title="Permalink to this headline">¶</a></h3> <p>Emitted when guest executes ACPI _OST method.</p> <div class="section" id="qapidoc-2885"> <h4>Arguments<a class="headerlink" href="#qapidoc-2885" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">info</span></code>: <code class="docutils literal notranslate"><span class="pre">ACPIOSTInfo</span></code></dt> <dd>OSPM Status Indication</dd> </dl> </div> <div class="section" id="qapidoc-2886"> <h4>Since<a class="headerlink" href="#qapidoc-2886" title="Permalink to this headline">¶</a></h4> <p>2.1</p> </div> <div class="section" id="qapidoc-2887"> <h4>Example<a class="headerlink" href="#qapidoc-2887" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><-</span> <span class="p">{</span> <span class="s2">"event"</span><span class="p">:</span> <span class="s2">"ACPI_DEVICE_OST"</span><span class="p">,</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="s2">"d1"</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> <span class="s2">"slot-type"</span><span class="p">:</span> <span class="s2">"DIMM"</span><span class="p">,</span> <span class="s2">"source"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"status"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> <span class="p">}</span> </pre></div> </div> </div> </div> </div> <div class="section" id="qapidoc-2889"> <h2><a class="toc-backref" href="#id565">PCI</a><a class="headerlink" href="#qapidoc-2889" title="Permalink to this headline">¶</a></h2> <div class="section" id="qapidoc-2892"> <h3><a class="toc-backref" href="#id566"><code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2892" title="Permalink to this headline">¶</a></h3> <p>A PCI device memory region</p> <div class="section" id="qapidoc-2890"> <h4>Members<a class="headerlink" href="#qapidoc-2890" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">base</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the starting address (guest physical)</dd> <dt><code class="docutils literal notranslate"><span class="pre">limit</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the ending address (guest physical)</dd> </dl> </div> <div class="section" id="qapidoc-2891"> <h4>Since<a class="headerlink" href="#qapidoc-2891" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2895"> <h3><a class="toc-backref" href="#id567"><code class="docutils literal notranslate"><span class="pre">PciMemoryRegion</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2895" title="Permalink to this headline">¶</a></h3> <p>Information about a PCI device I/O region.</p> <div class="section" id="qapidoc-2893"> <h4>Members<a class="headerlink" href="#qapidoc-2893" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bar</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the index of the Base Address Register for this region</dd> <dt><code class="docutils literal notranslate"><span class="pre">type</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd><ul class="first last simple"> <li>‘io’ if the region is a PIO region</li> <li>‘memory’ if the region is a MMIO region</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">size</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>memory size</dd> <dt><code class="docutils literal notranslate"><span class="pre">prefetch</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if <code class="docutils literal notranslate"><span class="pre">type</span></code> is ‘memory’, true if the memory is prefetchable</dd> <dt><code class="docutils literal notranslate"><span class="pre">mem_type_64</span></code>: <code class="docutils literal notranslate"><span class="pre">boolean</span></code> (optional)</dt> <dd>if <code class="docutils literal notranslate"><span class="pre">type</span></code> is ‘memory’, true if the BAR is 64-bit</dd> <dt><code class="docutils literal notranslate"><span class="pre">address</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>Not documented</dd> </dl> </div> <div class="section" id="qapidoc-2894"> <h4>Since<a class="headerlink" href="#qapidoc-2894" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2898"> <h3><a class="toc-backref" href="#id568"><code class="docutils literal notranslate"><span class="pre">PciBusInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2898" title="Permalink to this headline">¶</a></h3> <p>Information about a bus of a PCI Bridge device</p> <div class="section" id="qapidoc-2896"> <h4>Members<a class="headerlink" href="#qapidoc-2896" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">number</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>primary bus interface number. This should be the number of the bus the device resides on.</dd> <dt><code class="docutils literal notranslate"><span class="pre">secondary</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>secondary bus interface number. This is the number of the main bus for the bridge</dd> <dt><code class="docutils literal notranslate"><span class="pre">subordinate</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>This is the highest number bus that resides below the bridge.</dd> <dt><code class="docutils literal notranslate"><span class="pre">io_range</span></code>: <code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code></dt> <dd>The PIO range for all devices on this bridge</dd> <dt><code class="docutils literal notranslate"><span class="pre">memory_range</span></code>: <code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code></dt> <dd>The MMIO range for all devices on this bridge</dd> <dt><code class="docutils literal notranslate"><span class="pre">prefetchable_range</span></code>: <code class="docutils literal notranslate"><span class="pre">PciMemoryRange</span></code></dt> <dd>The range of prefetchable MMIO for all devices on this bridge</dd> </dl> </div> <div class="section" id="qapidoc-2897"> <h4>Since<a class="headerlink" href="#qapidoc-2897" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-2901"> <h3><a class="toc-backref" href="#id569"><code class="docutils literal notranslate"><span class="pre">PciBridgeInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2901" title="Permalink to this headline">¶</a></h3> <p>Information about a PCI Bridge device</p> <div class="section" id="qapidoc-2899"> <h4>Members<a class="headerlink" href="#qapidoc-2899" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bus</span></code>: <code class="docutils literal notranslate"><span class="pre">PciBusInfo</span></code></dt> <dd>information about the bus the device resides on</dd> <dt><code class="docutils literal notranslate"><span class="pre">devices</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">PciDeviceInfo</span></code> (optional)</dt> <dd>a list of <code class="docutils literal notranslate"><span class="pre">PciDeviceInfo</span></code> for each device on this bridge</dd> </dl> </div> <div class="section" id="qapidoc-2900"> <h4>Since<a class="headerlink" href="#qapidoc-2900" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2904"> <h3><a class="toc-backref" href="#id570"><code class="docutils literal notranslate"><span class="pre">PciDeviceClass</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2904" title="Permalink to this headline">¶</a></h3> <p>Information about the Class of a PCI device</p> <div class="section" id="qapidoc-2902"> <h4>Members<a class="headerlink" href="#qapidoc-2902" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">desc</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code> (optional)</dt> <dd>a string description of the device’s class</dd> <dt><code class="docutils literal notranslate"><span class="pre">class</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the class code of the device</dd> </dl> </div> <div class="section" id="qapidoc-2903"> <h4>Since<a class="headerlink" href="#qapidoc-2903" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-2907"> <h3><a class="toc-backref" href="#id571"><code class="docutils literal notranslate"><span class="pre">PciDeviceId</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2907" title="Permalink to this headline">¶</a></h3> <p>Information about the Id of a PCI device</p> <div class="section" id="qapidoc-2905"> <h4>Members<a class="headerlink" href="#qapidoc-2905" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">device</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the PCI device id</dd> <dt><code class="docutils literal notranslate"><span class="pre">vendor</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the PCI vendor id</dd> <dt><code class="docutils literal notranslate"><span class="pre">subsystem</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the PCI subsystem id (since 3.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">subsystem-vendor</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>the PCI subsystem vendor id (since 3.1)</dd> </dl> </div> <div class="section" id="qapidoc-2906"> <h4>Since<a class="headerlink" href="#qapidoc-2906" title="Permalink to this headline">¶</a></h4> <p>2.4</p> </div> </div> <div class="section" id="qapidoc-2911"> <h3><a class="toc-backref" href="#id572"><code class="docutils literal notranslate"><span class="pre">PciDeviceInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2911" title="Permalink to this headline">¶</a></h3> <p>Information about a PCI device</p> <div class="section" id="qapidoc-2908"> <h4>Members<a class="headerlink" href="#qapidoc-2908" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bus</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the bus number of the device</dd> <dt><code class="docutils literal notranslate"><span class="pre">slot</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the slot the device is located in</dd> <dt><code class="docutils literal notranslate"><span class="pre">function</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the function of the slot used by the device</dd> <dt><code class="docutils literal notranslate"><span class="pre">class_info</span></code>: <code class="docutils literal notranslate"><span class="pre">PciDeviceClass</span></code></dt> <dd>the class of the device</dd> <dt><code class="docutils literal notranslate"><span class="pre">id</span></code>: <code class="docutils literal notranslate"><span class="pre">PciDeviceId</span></code></dt> <dd>the PCI device id</dd> <dt><code class="docutils literal notranslate"><span class="pre">irq</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code> (optional)</dt> <dd>if an IRQ is assigned to the device, the IRQ number</dd> <dt><code class="docutils literal notranslate"><span class="pre">irq_pin</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the IRQ pin, zero means no IRQ (since 5.1)</dd> <dt><code class="docutils literal notranslate"><span class="pre">qdev_id</span></code>: <code class="docutils literal notranslate"><span class="pre">string</span></code></dt> <dd>the device name of the PCI device</dd> <dt><code class="docutils literal notranslate"><span class="pre">pci_bridge</span></code>: <code class="docutils literal notranslate"><span class="pre">PciBridgeInfo</span></code> (optional)</dt> <dd>if the device is a PCI bridge, the bridge information</dd> <dt><code class="docutils literal notranslate"><span class="pre">regions</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">PciMemoryRegion</span></code></dt> <dd>a list of the PCI I/O regions associated with the device</dd> </dl> </div> <div class="section" id="qapidoc-2909"> <h4>Notes<a class="headerlink" href="#qapidoc-2909" title="Permalink to this headline">¶</a></h4> <p>the contents of <code class="docutils literal notranslate"><span class="pre">class_info</span></code>.desc are not stable and should only be treated as informational.</p> </div> <div class="section" id="qapidoc-2910"> <h4>Since<a class="headerlink" href="#qapidoc-2910" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2914"> <h3><a class="toc-backref" href="#id573"><code class="docutils literal notranslate"><span class="pre">PciInfo</span></code> (Object)</a><a class="headerlink" href="#qapidoc-2914" title="Permalink to this headline">¶</a></h3> <p>Information about a PCI bus</p> <div class="section" id="qapidoc-2912"> <h4>Members<a class="headerlink" href="#qapidoc-2912" title="Permalink to this headline">¶</a></h4> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">bus</span></code>: <code class="docutils literal notranslate"><span class="pre">int</span></code></dt> <dd>the bus index</dd> <dt><code class="docutils literal notranslate"><span class="pre">devices</span></code>: <code class="docutils literal notranslate"><span class="pre">array</span> <span class="pre">of</span> <span class="pre">PciDeviceInfo</span></code></dt> <dd>a list of devices on this bus</dd> </dl> </div> <div class="section" id="qapidoc-2913"> <h4>Since<a class="headerlink" href="#qapidoc-2913" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> </div> <div class="section" id="qapidoc-2919"> <h3><a class="toc-backref" href="#id574"><code class="docutils literal notranslate"><span class="pre">query-pci</span></code> (Command)</a><a class="headerlink" href="#qapidoc-2919" title="Permalink to this headline">¶</a></h3> <p>Return information about the PCI bus topology of the guest.</p> <div class="section" id="qapidoc-2915"> <h4>Returns<a class="headerlink" href="#qapidoc-2915" title="Permalink to this headline">¶</a></h4> <p>a list of <code class="docutils literal notranslate"><span class="pre">PciInfo</span></code> for each PCI bus. Each bus is represented by a json-object, which has a key with a json-array of all PCI devices attached to it. Each device is represented by a json-object.</p> </div> <div class="section" id="qapidoc-2916"> <h4>Since<a class="headerlink" href="#qapidoc-2916" title="Permalink to this headline">¶</a></h4> <p>0.14</p> </div> <div class="section" id="qapidoc-2917"> <h4>Example<a class="headerlink" href="#qapidoc-2917" title="Permalink to this headline">¶</a></h4> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">-></span> <span class="p">{</span> <span class="s2">"execute"</span><span class="p">:</span> <span class="s2">"query-pci"</span> <span class="p">}</span> <span class="o"><-</span> <span class="p">{</span> <span class="s2">"return"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"devices"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"qdev_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"class_info"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="mi">1536</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"Host bridge"</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="mi">32902</span><span class="p">,</span> <span class="s2">"vendor"</span><span class="p">:</span> <span class="mi">4663</span> <span class="p">},</span> <span class="s2">"function"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"regions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">]</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"qdev_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"class_info"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="mi">1537</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"ISA bridge"</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="mi">32902</span><span class="p">,</span> <span class="s2">"vendor"</span><span class="p">:</span> <span class="mi">28672</span> <span class="p">},</span> <span class="s2">"function"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"regions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">]</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"qdev_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"class_info"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="mi">257</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"IDE controller"</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="mi">32902</span><span class="p">,</span> <span class="s2">"vendor"</span><span class="p">:</span> <span class="mi">28688</span> <span class="p">},</span> <span class="s2">"function"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"regions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"bar"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span> <span class="s2">"address"</span><span class="p">:</span> <span class="mi">49152</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"io"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"qdev_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"class_info"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="mi">768</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"VGA controller"</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="mi">4115</span><span class="p">,</span> <span class="s2">"vendor"</span><span class="p">:</span> <span class="mi">184</span> <span class="p">},</span> <span class="s2">"function"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"regions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"prefetch"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> <span class="s2">"mem_type_64"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"bar"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">33554432</span><span class="p">,</span> <span class="s2">"address"</span><span class="p">:</span> <span class="mi">4026531840</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"memory"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"prefetch"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"mem_type_64"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"bar"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">4096</span><span class="p">,</span> <span class="s2">"address"</span><span class="p">:</span> <span class="mi">4060086272</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"memory"</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"prefetch"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"mem_type_64"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> <span class="s2">"bar"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">65536</span><span class="p">,</span> <span class="s2">"address"</span><span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"memory"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">},</span> <span class="p">{</span> <span class="s2">"bus"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"qdev_id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> <span class="s2">"irq"</span><span class="p">:</span> <span class="mi">11</span><span class="p">,</span> <span class="s2">"slot"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> <span class="s2">"class_info"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"class"</span><span class="p">:</span> <span class="mi">1280</span><span class="p">,</span> <span class="s2">"desc"</span><span class="p">:</span> <span class="s2">"RAM controller"</span> <span class="p">},</span> <span class="s2">"id"</span><span class="p">:</span> <span class="p">{</span> <span class="s2">"device"</span><span class="p">:</span> <span class="mi">6900</span><span class="p">,</span> <span class="s2">"vendor"</span><span class="p">:</span> <span class="mi">4098</span> <span class="p">},</span> <span class="s2">"function"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"regions"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"bar"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"size"</span><span class="p">:</span> <span class="mi">32</span><span class="p">,</span> <span class="s2">"address"</span><span class="p">:</span> <span class="mi">49280</span><span class="p">,</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"io"</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> <span class="p">]</span> <span class="p">}</span> </pre></div> </div> </div> <div class="section" id="qapidoc-2918"> <h4>Note<a class="headerlink" href="#qapidoc-2918" title="Permalink to this headline">¶</a></h4> <p>This example has been shortened as the real response is too long.</p> </div> </div> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="qemu-storage-daemon-qmp-ref.html" class="btn btn-neutral float-right" title="QEMU Storage Daemon QMP Reference Manual" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="qemu-ga-ref.html" class="btn btn-neutral" title="QEMU Guest Agent Protocol Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2021, The QEMU Project Developers. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. <!-- Empty para to force a blank line after "Built with Sphinx ..." --> <p></p> <p>This documentation is for QEMU version 6.2.0.</p> <p><a href="../about/license.html">QEMU and this manual are released under the GNU General Public License, version 2.</a></p> </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'qemu-kvm-6.2.0-53.module+el8.10.0+2055+8eb7870b.4', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>
Simpan