NAME

       nbdkit-libvirt-plugin - nbdkit libvirt plugin using virDomainBlockPeek

SYNOPSIS

        nbdkit .../plugins/nbdkit-libvirt-plugin.so
          [connect=URI] domain=DOMAIN disk=DISK

EXAMPLE

        nbdkit .../plugins/nbdkit-libvirt-plugin.so domain=MyGuest disk=sda
        guestfish -a nbd://localhost

DESCRIPTION

       "nbdkit-libvirt-plugin" is an nbdkit(1) plugin that lets you access libvirt guest disks readonly.  It is
       implemented using the libvirt "virDomainBlockPeek" API.  It can also be used over remote libvirt
       connections.

PARAMETERS

       connect=URI
           This optional parameter specifies the libvirt connection URI.

       domain=DOMAIN
           This required parameter specifies the libvirt domain name (guest name).

       disk=DISK
           This required parameter specifies the guest's disk that we want to read.

           You can either give the path to the backing device ("/path/to/disk") or the target name (eg. "sda").

           In either case use "virsh dumpxml DOMAIN" to list possible disks.  Look for "<source dev=...>" or
           "<source file=...>" or "<target dev=...>" in the XML.

SEE ALSO

       nbdkit(1), nbdkit-plugin(3), <http://libvirt.org>.

AUTHORS

       Richard W.M. Jones

COPYRIGHT

       Copyright (C) 2013 Red Hat Inc.

LICENSE

       Redistribution and use in source and binary forms, with or without modification, are permitted provided
       that the following conditions are met:

       •   Redistributions of source code must retain the above copyright notice, this list of conditions and
           the following disclaimer.

       •   Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
           the following disclaimer in the documentation and/or other materials provided with the distribution.

       •   Neither the name of Red Hat nor the names of its contributors may be used to endorse or promote
           products derived from this software without specific prior written permission.

       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
       INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
       INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
       ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
       DAMAGE.