=============
virt-qemu-run
=============

---------------------------
Run a standalone QEMU guest
---------------------------

:Manual section: 1
:Manual group: Virtualization Support

.. contents::

SYNOPSIS
========

``virt-qemu-run [OPTIONS...] [GUEST-XML]``

DESCRIPTION
===========

This tool provides a way to run a standalone QEMU guest such that it
is completely independent of libvirtd. It makes use of the embedded
QEMU driver support to run the VM placing files under an isolated
directory tree. When the guest is run with this tool it is invisible
to libvirtd and thus also invisible to other libvirt tools such as
virsh.

The virt-qemu-run program will run the QEMU virtual machine, and then
block until the guest OS shuts down, at which point it will exit.

If the virt-qemu-run program is interrupted (eg Ctrl-C) it will
immediately terminate the virtual machine without giving the guest
OS any opportunity to gracefully shutdown.

**NOTE: this tool is currently considered experimental.** Its
usage and behaviour is still subject to change in future libvirt
releases. For further information on its usage consult the
`QEMU driver documentation <https://libvirt.org/drvqemu.html#uriembedded>`_.

OPTIONS
=======

``GUEST-XML``

The full path to the XML file describing the guest virtual machine
to be booted.

``-h``, ``--help``

Display the command line help

``-v``, ``--verbose``

Display verbose information about startup

``-r DIR``, ``--root=DIR``

Specify the root directory to use for storing state associated with
the virtual machine. The caller is responsible for deleting this
directory when it is no longer required.

If this parameter is omitted, then a random temporary directory
will be created, and its contents be automaticlaly deleted at
VM shutdown.

``-s XML-FILE,VALUE-FILE``, ``--secret=XML-FILE,VALUE-FILE``

Specify a secret to be loaded into the secret driver. The ``XML-FILE``
is a path to the XML description of the secret, whose UUID should
match a secret referenced in the guest domain XML. The ``VALUE-FILE``
is a path containing the raw value of the secret.

EXIT STATUS
===========

Upon successful shutdown, an exit status of 0 will be set. Upon
failure a non-zero status will be set.

AUTHOR
======

Daniel P. Berrangé


BUGS
====

Please report all bugs you discover.  This should be done via either:

#. the mailing list

   `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_

#. the bug tracker

   `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_

Alternatively, you may report bugs to your software distributor / vendor.


COPYRIGHT
=========

Copyright (C) 2019 by Red Hat, Inc.


LICENSE
=======

``virt-run-qemu`` 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

SEE ALSO
========

virsh(1), `https://libvirt.org/ <https://libvirt.org/>`_
