1nbdkit-ext2-plugin(1)               NBDKIT               nbdkit-ext2-plugin(1)
2
3
4

NAME

6       nbdkit-ext2-plugin - read and write files inside ext2, ext3 or ext4
7       filesystems
8

SYNOPSIS

10        nbdkit ext2 disk=fs.img file=/disks/disk.raw
11
12        nbdkit --filter=partition ext2 \
13                                  disk=disk.img file=/disks/disk.raw \
14                                  partition=1
15

DESCRIPTION

17       "nbdkit-ext2-plugin" is an nbdkit plugin which can read and write files
18       inside ext2, ext3 or ext4 filesystem images.
19
20       Suppose you have an ext2/3/4 filesystem image called fs.img which
21       contains inside itself a file called disk.raw inside a directory on the
22       filesystem called /disks, then you could serve that file over NBD
23       using:
24
25        nbdkit ext2 disk=fs.img file=/disks/disk.raw
26
27       Commonly disk images are partitioned.  In that case you must use
28       nbdkit-partition-filter(1) to select the partition:
29
30        nbdkit --filter=partition ext2 disk=.. file=.. partition=1
31
32       This plugin can both read and write to the file inside the filesystem.
33       Use the -r flag to force a readonly connection, but note this does not
34       guarantee that no writes are made to the filesystem.  In particular we
35       may have to replay the ext3 journal in order to open a filesystem even
36       read-only.
37
38       The plugin does not support multiple parallel connections, because
39       there is a risk of corrupting the filesystem (as if the filesystem was
40       mounted by multiple machines).  If a second connection is made to
41       nbdkit, it will block until the first connection closes.
42
43       The plugin is implemented using the ext2fs library which is provided in
44       most Linux distros, and also available as part of the e2fsprogs
45       project.
46
47       nbdkit-guestfs-plugin(1) is a more generic plugin which can read files
48       from all kinds of different filesystem types, even if they are
49       partitioned or use logical volumes.  It uses libguestfs instead of
50       e2fsprogs.
51

PARAMETERS

53       disk=FILENAME
54           The ext2, ext3 or ext4 filesystem, a file on the host.
55
56           You could also use a device name here if the filesystem is located
57           on a device.  Be careful that the filesystem is not being accessed
58           in parallel by another program and is not mounted, as that will
59           almost certainly result in disk corruption in the filesystem.
60
61           The plugin expects a raw filesystem.  If the file/device is
62           partitioned, use nbdkit-partition-filter(1).
63
64       file=PATH
65           The full path of the file within the filesystem that will be
66           exposed over NBD.  The path must be absolute (starts with "/").
67

FILES

69       $plugindir/nbdkit-ext2-plugin.so
70           The plugin.
71
72           Use "nbdkit --dump-config" to find the location of $plugindir.
73

VERSION

75       "nbdkit-ext2-plugin" first appeared in nbdkit 1.4.
76

SEE ALSO

78       nbdkit(1), nbdkit-plugin(3), nbdkit-partition-filter(1),
79       nbdkit-guestfs-plugin(1), http://e2fsprogs.sourceforge.net/,
80       fuse2fs(1).
81

AUTHORS

83       Richard W.M. Jones
84

86       Copyright (C) 2018 Red Hat Inc.
87

LICENSE

89       Redistribution and use in source and binary forms, with or without
90       modification, are permitted provided that the following conditions are
91       met:
92
93       ·   Redistributions of source code must retain the above copyright
94           notice, this list of conditions and the following disclaimer.
95
96       ·   Redistributions in binary form must reproduce the above copyright
97           notice, this list of conditions and the following disclaimer in the
98           documentation and/or other materials provided with the
99           distribution.
100
101       ·   Neither the name of Red Hat nor the names of its contributors may
102           be used to endorse or promote products derived from this software
103           without specific prior written permission.
104
105       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
106       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
107       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
108       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
109       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
110       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
111       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
112       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
113       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
114       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
115       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
116
117
118
119nbdkit-1.16.1                     2019-12-03             nbdkit-ext2-plugin(1)
Impressum