.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.36.3 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-libvirt-plugin 1"
.TH nbdkit-libvirt-plugin 1 2024-01-17 nbdkit-1.36.3 NBDKIT
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbdkit\-libvirt\-plugin \- nbdkit libvirt plugin using virDomainBlockPeek
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& nbdkit libvirt [connect=URI] domain=DOMAIN disk=DISK
.Ve
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 2
\& nbdkit libvirt domain=MyGuest disk=sda
\& guestfish \-\-ro \-\-format=raw \-a nbd://localhost
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`nbdkit\-libvirt\-plugin\*(C'\fR is an \fBnbdkit\fR\|(1) plugin that lets you
access libvirt guest disks.  Only read-only access is possible.  It is
implemented using the libvirt \f(CW\*(C`virDomainBlockPeek\*(C'\fR API.  It can also
be used over remote libvirt connections.
.SH PARAMETERS
.IX Header "PARAMETERS"
.IP \fBconnect=\fRURI 4
.IX Item "connect=URI"
This optional parameter specifies the libvirt connection URI.
.IP \fBdomain=\fRDOMAIN 4
.IX Item "domain=DOMAIN"
This required parameter specifies the libvirt domain name
(guest name).
.IP \fBdisk=\fRDISK 4
.IX Item "disk=DISK"
This required parameter specifies the guest's disk that we want to
read.
.Sp
You can either give the path to the backing device (\fI/path/to/disk\fR)
or the target name (eg. \f(CW\*(C`sda\*(C'\fR).
.Sp
In either case use \f(CW\*(C`virsh dumpxml DOMAIN\*(C'\fR to list possible disks.
Look for \f(CW\*(C`<source\ dev=...>\*(C'\fR or
\&\f(CW\*(C`<source\ file=...>\*(C'\fR or
\&\f(CW\*(C`<target\ dev=...>\*(C'\fR in the XML.
.SH FILES
.IX Header "FILES"
.ie n .IP \fR\fI$plugindir\fR\fI/nbdkit\-libvirt\-plugin.so\fR 4
.el .IP \fR\f(CI$plugindir\fR\fI/nbdkit\-libvirt\-plugin.so\fR 4
.IX Item "$plugindir/nbdkit-libvirt-plugin.so"
The plugin.
.Sp
Use \f(CW\*(C`nbdkit \-\-dump\-config\*(C'\fR to find the location of \f(CW$plugindir\fR.
.SH VERSION
.IX Header "VERSION"
\&\f(CW\*(C`nbdkit\-libvirt\-plugin\*(C'\fR first appeared in nbdkit 1.0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-plugin\fR\|(3),
http://libvirt.org,
https://libvirt.org/html/libvirt\-libvirt\-domain.html#virDomainBlockPeek.
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
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.
.IP \(bu 4
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.
.PP
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.