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

NAME

6       nbdkit-null-plugin - nbdkit bitbucket plugin
7

SYNOPSIS

9        nbdkit null [[size=]SIZE]
10

DESCRIPTION

12       "nbdkit-null-plugin" is a null plugin for nbdkit(1).  Everything
13       written to the virtual device is discarded, and reads back as zeroes.
14
15       Most NBD consumers will be very confused by this device.  Trying to
16       create filesystems etc on it will likely fail badly.  If the client is
17       caching writes locally then you will get inconsistent read behaviour.
18
19       The null plugin is also used when probing for installed filters, see
20       "Detect if a filter is installed" in nbdkit-probing(1).
21

PARAMETERS

23       [size=]SIZE
24           Specify the virtual size of the disk image.
25
26           This parameter is optional.  If omitted then a zero-sized device is
27           created.
28
29           "size=" is a magic config key and may be omitted in most cases.
30           See "Magic parameters" in nbdkit(1).
31

FILES

33       $plugindir/nbdkit-null-plugin.so
34           The plugin.
35
36           Use "nbdkit --dump-config" to find the location of $plugindir.
37

VERSION

39       "nbdkit-null-plugin" first appeared in nbdkit 1.2.
40

SEE ALSO

42       nbdkit(1), nbdkit-plugin(3), nbdkit-full-plugin(1),
43       nbdkit-pattern-plugin(1), nbdkit-random-plugin(1).
44       nbdkit-sparse-random-plugin(1), nbdkit-zero-plugin(1).
45

AUTHORS

47       Richard W.M. Jones
48

50       Copyright Red Hat
51

LICENSE

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