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

NAME

6       nbdkit-full-plugin - nbdkit plugin which is always full
7

SYNOPSIS

9        nbdkit full [size=]SIZE
10

DESCRIPTION

12       "nbdkit-full-plugin" is a plugin for nbdkit(1).  Reads from this
13       virtual disk return zeroes.  All writes and similar operations like
14       zero and trim fail with "ENOSPC" (No space left on device) error.
15
16       In other words this behaves like a sparse (thin-provisioned) virtual
17       disk which has run out of space on the host.
18
19   Equivalent nbdkit-error-filter command
20       Although this is a standalone plugin, it is equivalent to using
21       nbdkit-error-filter(1):
22
23        nbdkit --filter=error null SIZE \
24                              error-pwrite=ENOSPC error-pwrite-rate=100% \
25                              error-trim=ENOSPC error-trim-rate=100% \
26                              error-zero=ENOSPC error-zero-rate=100%
27
28       nbdkit-error-filter can be more flexible because you can place it on
29       top of other plugins and you can control when to inject errors.
30

PARAMETERS

32       [size=]SIZE
33           Specify the virtual size of the disk image.
34
35           This parameter is required.
36
37           "size=" is a magic config key and may be omitted in most cases.
38           See "Magic parameters" in nbdkit(1).
39

FILES

41       $plugindir/nbdkit-full-plugin.so
42           The plugin.
43
44           Use "nbdkit --dump-config" to find the location of $plugindir.
45

VERSION

47       "nbdkit-full-plugin" first appeared in nbdkit 1.10.
48

SEE ALSO

50       nbdkit(1), nbdkit-plugin(3), nbdkit-error-filter(1),
51       nbdkit-null-plugin(1), nbdkit-pattern-plugin(1),
52       nbdkit-random-plugin(1).  nbdkit-sparse-random-plugin(1),
53       nbdkit-zero-plugin(1).
54

AUTHORS

56       Richard W.M. Jones
57

59       Copyright (C) 2017-2020 Red Hat Inc.
60

LICENSE

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