plugins/libvirt/nbdkit-libvirt-plugin.pod

   1 =head1 NAME
   2
   3 nbdkit-libvirt-plugin - nbdkit libvirt plugin using virDomainBlockPeek
   4
   5 =head1 SYNOPSIS
   6
   7  nbdkit libvirt [connect=URI] domain=DOMAIN disk=DISK
   8
   9 =head1 EXAMPLE
  10
  11  nbdkit libvirt domain=MyGuest disk=sda
  12  guestfish --ro --format=raw -a nbd://localhost
  13
  14 =head1 DESCRIPTION
  15
  16 C<nbdkit-libvirt-plugin> is an L<nbdkit(1)> plugin that lets you
  17 access libvirt guest disks.  Only read-only access is possible.  It is
  18 implemented using the libvirt C<virDomainBlockPeek> API.  It can also
  19 be used over remote libvirt connections.
  20
  21 =head1 PARAMETERS
  22
  23 =over 4
  24
  25 =item B<connect=>URI
  26
  27 This optional parameter specifies the libvirt connection URI.
  28
  29 =item B<domain=>DOMAIN
  30
  31 This required parameter specifies the libvirt domain name
  32 (guest name).
  33
  34 =item B<disk=>DISK
  35
  36 This required parameter specifies the guest's disk that we want to
  37 read.
  38
  39 You can either give the path to the backing device (F</path/to/disk>)
  40 or the target name (eg. C<sda>).
  41
  42 In either case use C<virsh dumpxml DOMAIN> to list possible disks.
  43 Look for S<C<E<lt>source dev=...E<gt>>> or
  44 S<C<E<lt>source file=...E<gt>>> or
  45 S<C<E<lt>target dev=...E<gt>>> in the XML.
  46
  47 =back
  48
  49 =head1 FILES
  50
  51 =over 4
  52
  53 =item F<$plugindir/nbdkit-libvirt-plugin.so>
  54
  55 The plugin.
  56
  57 Use C<nbdkit --dump-config> to find the location of C<$plugindir>.
  58
  59 =back
  60
  61 =head1 VERSION
  62
  63 C<nbdkit-libvirt-plugin> first appeared in nbdkit 1.0.
  64
  65 =head1 SEE ALSO
  66
  67 L<nbdkit(1)>,
  68 L<nbdkit-plugin(3)>,
  69 L<http://libvirt.org>,
  70 L<https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainBlockPeek>.
  71
  72 =head1 AUTHORS
  73
  74 Richard W.M. Jones
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright Red Hat