1nbdkit-libvirt-plugin(1) NBDKIT nbdkit-libvirt-plugin(1)
2
3
4
6 nbdkit-libvirt-plugin - nbdkit libvirt plugin using virDomainBlockPeek
7
9 nbdkit libvirt [connect=URI] domain=DOMAIN disk=DISK
10
12 nbdkit libvirt domain=MyGuest disk=sda
13 guestfish --ro --format=raw -a nbd://localhost
14
16 "nbdkit-libvirt-plugin" is an nbdkit(1) plugin that lets you access
17 libvirt guest disks. Only read-only access is possible. It is
18 implemented using the libvirt "virDomainBlockPeek" API. It can also be
19 used over remote libvirt connections.
20
22 connect=URI
23 This optional parameter specifies the libvirt connection URI.
24
25 domain=DOMAIN
26 This required parameter specifies the libvirt domain name (guest
27 name).
28
29 disk=DISK
30 This required parameter specifies the guest's disk that we want to
31 read.
32
33 You can either give the path to the backing device (/path/to/disk)
34 or the target name (eg. "sda").
35
36 In either case use "virsh dumpxml DOMAIN" to list possible disks.
37 Look for "<source dev=...>" or "<source file=...>" or
38 "<target dev=...>" in the XML.
39
41 $plugindir/nbdkit-libvirt-plugin.so
42 The plugin.
43
44 Use "nbdkit --dump-config" to find the location of $plugindir.
45
47 "nbdkit-libvirt-plugin" first appeared in nbdkit 1.0.
48
50 nbdkit(1), nbdkit-plugin(3), http://libvirt.org,
51 https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainBlockPeek.
52
54 Richard W.M. Jones
55
57 Copyright (C) 2013-2020 Red Hat Inc.
58
60 Redistribution and use in source and binary forms, with or without
61 modification, are permitted provided that the following conditions are
62 met:
63
64 • Redistributions of source code must retain the above copyright
65 notice, this list of conditions and the following disclaimer.
66
67 • Redistributions in binary form must reproduce the above copyright
68 notice, this list of conditions and the following disclaimer in the
69 documentation and/or other materials provided with the
70 distribution.
71
72 • Neither the name of Red Hat nor the names of its contributors may
73 be used to endorse or promote products derived from this software
74 without specific prior written permission.
75
76 THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
77 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
78 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
79 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
80 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
81 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
82 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
83 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
84 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
85 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
86 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
87
88
89
90nbdkit-1.30.7 2022-07-10 nbdkit-libvirt-plugin(1)