VIRT-QEMU-QMP-PROXY(1)

📦
version 12.8.0 · 5 versions
, in centos-stream 10, debian bookworm, ubuntu noble

💅 virt-qemu-qmp-proxy — the manual, but make it make sense

okay so real talk, this is virt-qemu-qmp-proxy(1), and it lives in the Virtualization Support manual section. she's a whole vibe and honestly kind of a big deal. let's get into it 🎀

✨ NAME ✨

virt-qemu-qmp-proxy — expose a QMP proxy server for a libvirt QEMU guest. yes bestie, that's literally her whole job 💖

🦋 SYNOPSIS 🦋

virt-qemu-qmp-proxy [OPTION]... DOMAIN QMP-SOCKET-PATH

🌸 DESCRIPTION 🌸

so what this tool does is give you a way to expose a QMP proxy server that talks to a QEMU guest managed by libvirt. the whole point? it lets standard QMP client tools interact with libvirt managed guests. that's it. that's the slay ✨

NOTE: using this tool will result in the running QEMU guest being marked as tainted. it is strongly recommended that this tool only be used to send commands which query information about the running guest. if you use this tool to make changes to the state of the guest, this may have negative interactions with the QEMU driver, resulting in an inability to manage the guest operation thereafter, and in the worst case potentially lead to data loss or corruption. 😭 so like... read-only energy only, pls. i'm serious, this is the one time i'm not joking around.

the virt-qemu-qmp-proxy program will listen on a UNIX socket for incoming client connections, and run the QMP protocol over the connection. any commands received will be sent to the running libvirt guest, and replies sent back. like a little messenger fairy 🧚

the virt-qemu-qmp-proxy program may be interrupted (eg Ctrl-C) when it is no longer required. and the good news? the libvirt QEMU guest will continue running. she survives without you, no cap 🫶

⭐ OPTIONS ⭐

  • DOMAIN — the ID or UUID or Name of the libvirt QEMU guest. any of the three, you pick, she's flexible 💅
  • QMP-SOCKET-PATH — the filesystem path at which to run the QMP server, listening for incoming connections. that's where the magic happens ✨
  • -c CONNECTION-URI, --connect=CONNECTION-URI — the URI for the connection to the libvirt QEMU driver. if you omit it, a URI will be auto-detected. she'll figure it out herself, she's smart like that 🌈
  • -v, --verbose — run in verbose mode, printing all QMP commands and replies that are handled. for the girlies who need to see everything 👀
  • -h, --help — display the command line help. the classic. we love her 💜

🍓 EXIT STATUS 🍓

upon successful shutdown, an exit status of 0 will be set. upon failure a non-zero status will be set. simple, clean, iconic 👑

💫 AUTHOR 💫

Daniel P. Berrangé — the main character who made this happen 🫶

💀 BUGS 💀

please report all bugs you discover. this should be done via either:

  1. the mailing list

https://libvirt.org/contact.html

  1. the bug tracker

https://libvirt.org/bugs.html

alternatively, you may report bugs to your software distributor / vendor. they'll pass it along, no worries 🐛

Copyright (C) 2022 by Red Hat, Inc.

💖 LICENSE 💖

virt-qemu-qmp-proxy is distributed under the terms of the GNU LGPL v2+. this is free software; see the source for copying conditions. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. like zero warranty. none. don't come for her 😭

👑 SEE ALSO 👑

virsh(1), https://libvirt.org/, QMP reference

okay that's the whole thing, you're now officially caught up bestie 🌸 this was VIRT-QEMU-QMP-PROXY(1) from the Virtualization Support manual, brought to you with love, and yes she's still called that in the footer even though we're being cute about it. mwah 💋✨

📦 where this page comes from