1nbdkit-partition-filter(1)          NBDKIT          nbdkit-partition-filter(1)
2
3
4

NAME

6       nbdkit-partition-filter - nbdkit partition filter
7

SYNOPSIS

9        nbdkit --filter=partition plugin partition=PART [plugin-args...]
10

DESCRIPTION

12       "nbdkit-partition-filter" is a filter that limits requests to a single
13       partition within a disk image that is served by another plugin.
14
15       Partition numbers are specified by the required "partition" parameter,
16       and count from 1.
17
18       This works like the "qemu-nbd -P" option.
19
20       The opposite of this filter is nbdkit-partitioning-plugin(1) which adds
21       a virtual partition table to a file or files.
22

PARAMETERS

24       partition=PART
25           The partition number to serve, counting from 1.
26
27           This parameter is required.
28

EXAMPLE

30       disk.img is a partitioned disk image (eg. a virtual machine disk
31       image).  To serve the first partition only use:
32
33        nbdkit --filter=partition file disk.img partition=1
34

FILES

36       $filterdir/nbdkit-partition-filter.so
37           The filter.
38
39           Use "nbdkit --dump-config" to find the location of $filterdir.
40

VERSION

42       "nbdkit-partition-filter" first appeared in nbdkit 1.2.
43

SEE ALSO

45       nbdkit(1), nbdkit-file-plugin(1), nbdkit-filter(3),
46       nbdkit-offset-filter(1), nbdkit-partitioning-plugin(1),
47       nbdkit-truncate-filter(1), parted(8).
48

AUTHORS

50       Eric Blake
51
52       Richard W.M. Jones
53
55       Copyright (C) 2018 Red Hat Inc.
56

LICENSE

58       Redistribution and use in source and binary forms, with or without
59       modification, are permitted provided that the following conditions are
60       met:
61
62       •   Redistributions of source code must retain the above copyright
63           notice, this list of conditions and the following disclaimer.
64
65       •   Redistributions in binary form must reproduce the above copyright
66           notice, this list of conditions and the following disclaimer in the
67           documentation and/or other materials provided with the
68           distribution.
69
70       •   Neither the name of Red Hat nor the names of its contributors may
71           be used to endorse or promote products derived from this software
72           without specific prior written permission.
73
74       THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND ANY
75       EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
76       IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
77       PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR CONTRIBUTORS BE
78       LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
79       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
80       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
81       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
82       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
83       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
84       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
85
86
87
88nbdkit-1.28.2                     2021-11-09        nbdkit-partition-filter(1)
Impressum