plugins/libvirt/nbdkit-libvirt-plugin.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 nbdkit-libvirt-plugin - nbdkit libvirt plugin using virDomainBlockPeek
   6
   7 =head1 SYNOPSIS
   8
   9  nbdkit libvirt [connect=URI] domain=DOMAIN disk=DISK
  10
  11 =head1 EXAMPLE
  12
  13  nbdkit libvirt domain=MyGuest disk=sda
  14  guestfish -a nbd://localhost
  15
  16 =head1 DESCRIPTION
  17
  18 C<nbdkit-libvirt-plugin> is an L<nbdkit(1)> plugin that lets you
  19 access libvirt guest disks readonly.  It is implemented using the
  20 libvirt C<virDomainBlockPeek> API.  It can also be used over remote
  21 libvirt connections.
  22
  23 =head1 PARAMETERS
  24
  25 =over 4
  26
  27 =item B<connect=URI>
  28
  29 This optional parameter specifies the libvirt connection URI.
  30
  31 =item B<domain=DOMAIN>
  32
  33 This required parameter specifies the libvirt domain name
  34 (guest name).
  35
  36 =item B<disk=DISK>
  37
  38 This required parameter specifies the guest's disk that we want to
  39 read.
  40
  41 You can either give the path to the backing device (C</path/to/disk>)
  42 or the target name (eg. C<sda>).
  43
  44 In either case use C<virsh dumpxml DOMAIN> to list possible disks.
  45 Look for S<C<E<lt>source dev=...E<gt>>> or
  46 S<C<E<lt>source file=...E<gt>>> or
  47 S<C<E<lt>target dev=...E<gt>>> in the XML.
  48
  49 =back
  50
  51 =head1 SEE ALSO
  52
  53 L<nbdkit(1)>,
  54 L<nbdkit-plugin(3)>,
  55 L<http://libvirt.org>.
  56
  57 =head1 AUTHORS
  58
  59 Richard W.M. Jones
  60
  61 =head1 COPYRIGHT
  62
  63 Copyright (C) 2013 Red Hat Inc.
  64
  65 =head1 LICENSE
  66
  67 Redistribution and use in source and binary forms, with or without
  68 modification, are permitted provided that the following conditions are
  69 met:
  70
  71 =over 4
  72
  73 =item *
  74
  75 Redistributions of source code must retain the above copyright
  76 notice, this list of conditions and the following disclaimer.
  77
  78 =item *
  79
  80 Redistributions in binary form must reproduce the above copyright
  81 notice, this list of conditions and the following disclaimer in the
  82 documentation and/or other materials provided with the distribution.
  83
  84 =item *
  85
  86 Neither the name of Red Hat nor the names of its contributors may be
  87 used to endorse or promote products derived from this software without
  88 specific prior written permission.
  89
  90 =back
  91
  92 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
  93 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  94 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  95 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
  96 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  98 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  99 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 100 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 101 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 102 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 103 SUCH DAMAGE.